Web service specification V3 eNaročanje
| Project name |
eNaročanje |
| Document version |
3.62 |
| Creation date |
01.03.2020 |
| Last updated |
19.01.2026 |
| Authors |
IN2 |
The API of the central ordering system is implemented using a set of
methods in a web service. All methods consist of two parameters:
Version parameter - the version of the message which is being
sent. In the future, when change of the message structure occurs,
version parameter will be updated. System supports version n
and n-1. Current version of all messages is 3.
Message parameter - the message, structured as XML. Schema
definitions are provided in this document. In case of referral data,
XML schema is validated with openEHR schema definitions.
Security token (generated by security model) will be required in each
method call.
2. Error handling
Every response has the SuccessStatus (based on the catalogue
SuccessStatus) element which provides the information
if the request was processed successfully. In case that SuccessStatus is
set to Fail or Partial then is obligatory to send a list of errors.
Every error has the error code (based on the catalogue
ErrorCodeType).
Partial status can only be applied for CancelAppointments,
CreateAppointments and UpdateAppointments when there is the possibility
that during the processing some appointments can be processed and some
not.
Example: COS receives a CancelAppointments method call with 5
appointments and 2 appointments have some validation errors. In that
case COS will regularly process the 3 valid appoinemtns and for the
invalid the details will be provided in the Error section of the
response.
XML Example:
<Response xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SuccessStatus>2</SuccessStatus>
<ErrorList>
<Error>
<Code>1</Code>
<Description>test1</Description>
</Error>
<Error>
<Code>2</Code>
<Description>test2</Description>
</Error>
</ErrorList>
</Response>
3. Paging
In GetAppointmentForProcedureHOS and GetRealisationForProcedureHOS
processes, there could be a situation when there is a large number of
appointments that cannot be sent in one message due to the length
limitation of the protocol. For this purpose, central ordering system
(COS) supports paging, a principle where the total number of
appointments is divided into smaller portions - pages. Each page is
then communicated with COS through sequential requests and responses.
The initial request from COS is in the same format like before
containing no new fields. If the HOS determines that paging should be
used, it responds to the COS with new fields in response message. After
that, every new request from COS for that medical procedure contains the
page number that should be returned.
If used, PagingInfo contains the following elements:
| Element name |
Element description |
| PageNumber |
The number of page for which appointments are returned |
| PageSize |
Number of appointments sent in current page/response |
| RemainingNumber |
Number of appointments that are not yet sent to COS; when value is equal to 0 paging is complete and it is considered that all appointments are sent to COS |
| TotalNumber |
Total number of appointments for current medical procedure (the sum of appointments sent throughout all pages) |
XML Example:
<PagingInfo>
<PageNumber>1</PageNumber>
<PageSize>1</PageSize>
<RemainingNumber>0</RemainingNumber>
<TotalNumber>1</TotalNumber>
</PagingInfo>
4. COS web service
Central Ordering System (COS) methods:
Referrals:
1. string GetNewReferralId(int version, string request)
2. string GetGuidilineForProcedure(int version, string request)
3. string SubmitReferral(int version, string request, string referral, byte[] signature)
4. string GetReferral(int version, string request, out string referralXml)
5. string GetReferralList(int version, string request)
Attachments:
1. string CreateReferralAttachment(int version, string request)
2. string UpdateReferralAttachment(int version, string request)
3. string DeleteReferralAttachment(int version, string request)
4. string GetReferralAttachment(int version, string request)
5. string GetReferralAttachmentList(int version, string request)
Appointments:
1. string CreateAppointments(int version, string request)
2. string CreateAdmission(int version, string request)
3. string AppointmentRealisation(int version, string request)
4. string CancelAppointmentRealisation(int version, string request)
5. string CancelAdmission(int version, string request)
6. string CancelAppointments(int version, string request)
7. string GetAppointment(int version, string request)
8. string GetAppointmentsForPatient(int version, string request)
9. string UpdateAppointments(int version, string request)
10. string GetAppointmentPDF(int version, string request)
11. string GetAEUCandidates(int version, string request)
Tasks:
1. string CreateTask(int version, string request)
2. string SendMessage(int version, string request)
3. string GetTaskList(int version, string request)
4. string GetReferralChanges(int version, string request)
5. string CloseTask(int version, string request)
6. string UpdateUrgencyTypeCode(int version, string request)
Concessioners:
1. string RegisterConcessioner(int version, string request)
2. string RegisterProceduresForConcessioner(int version, string request)
Web:
1. string GetFreeSlotForProcedureCOS(int version, string request)
2. string BookReservationCOS(int version, string request)
3. string CancelReservationCOS(int version, string request)
4. string GetPrereservationForProcedureCOS(int version, string request)
4.1 GetNewReferrald
Method that can be called in 2 cases:
It is mandatory to call this method before creating a new referral.
The method will return the referral unique identifier and the key
for signing the referral document.
It must be called to get the key for signing the document for
Update/Cancel. In that case it is mandatory to provide the referral
unique identifier.
GetNewReferralIdRequest
XSD Schema:
<?xml version=“1.0“ encoding=“utf-8“?>
<xs:schema xmlns:xs=“http://www.w3.org/2001/XMLSchema“>
<xs:include schemaLocation=“Common.xsd“ />
<xs:element name=“GetNewReferralIdRequest“>
<xs:complexType>
<xs:all>
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“ApiKey“ type=“NonEmptyString“ />
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“HealthcareProviderIndex“ type=“BPIType“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“HealthcareProviderSpecificIndex“ type=“BPIspecificType“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“ReferralUniqueIdentifier“ type=“ReferralUidType“ />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version=“1.0“ encoding=“utf-8“?>
<GetNewReferralIdRequest xmlns:xsi=“http://www.w3.org/2001/XMLSchema-instance“ xmlns:xsd=“http://www.w3.org/2001/XMLSchema“>
<ApiKey>ApiKey1</ApiKey>
<HealthcareProviderIndex>10000</HealthcareProviderIndex>
</GetNewReferralIdRequest>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| ApiKey |
Application key of the application making the request |
YES |
| HealthcareProviderIndex |
Medical facility code (BPI) |
YES |
| HealthcareProviderSpecificIndex |
Medical facility specific code (Used when multiple software vendors maintain the IS of the same facility) |
Only if exists |
| ReferralUniqueIdentifier |
Referral unique identifier |
Only for Cancel/Update |
GetNewReferralIdResponse
XSD Schema:
<?xml version=“1.0“ encoding=“utf-8“?>
<xs:schema xmlns:xs=“http://www.w3.org/2001/XMLSchema“>
<xs:include schemaLocation=“Common.xsd“ />
<xs:element name=“GetNewReferralIdResponse“>
<xs:complexType>
<xs:all>
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“SuccessStatus“ type=“SuccessStatusType“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“ErrorList“ type=“ErrorListType“/>
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“ReferralUniqueIdentifier“ type=“ReferralUidType“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“XdsDocumentHandleUniqueId“ type=“xs:string“ />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version=“1.0“ encoding=“utf-8“?>
<GetNewReferralIdResponse xmlns:xsi=“http://www.w3.org/2001/XMLSchema-instance“ xmlns:xsd=“http://www.w3.org/2001/XMLSchema“>
<SuccessStatus>1</SuccessStatus>
<ReferralUniqueIdentifier>1234567891234</ReferralUniqueIdentifier>
<XdsDocumentHandleUniqueId />
</GetNewReferralIdResponse>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| SuccessStatus |
References catalogue SuccessStatus |
YES |
| ErrorList |
List of errors |
If SuccessStatus is set to Fail |
| ReferralUniqueIdentifier |
Referral unique identifier |
If SuccessStatus is set to Success |
| XdsDocumentHandleUniqueId |
Key for document signing |
If SuccessStatus is set to Success |
4.2 GetGuidelineForProcedure
This method must be called before calling SubmitReferral (Action: Create) method. GuidelineID identifier has to be obtained so it can be passed as parameter when calling SubmitReferral (Action: Create). If medical procedure does not have guideline, empty GuidelineID will be returned. SubmitReferral (Action: Create) method, in that case, can be called with empty GuidelineID.
GetGuidelineForProcedureRequest
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd"/>
<xs:element name="GetGuidelineForProcedureRequest">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="ApiKey" type="NonEmptyString"/>
<xs:element minOccurs="1" maxOccurs="1" name="MedicalProcedureCode" type="MedicalProcedureCodeType"/>
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<GetGuidelineForProcedureRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ApiKey>test</ApiKey>
<MedicalProcedureCode>1240P</MedicalProcedureCode>
</GetGuidelineForProcedureRequest>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| ApiKey |
Application key of the application making the request |
YES |
| MedicalProcedureCode |
Medical procedure unique identifier (VZS) |
YES |
GetGuidelineForProcedureResponse
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd"/>
<xs:element name="GetGuidelineForProcedureResponse">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="SuccessStatus" type="SuccessStatusType"/>
<xs:element minOccurs="0" maxOccurs="1" name="ErrorList" type="ErrorListType"/>
<xs:element minOccurs="0" maxOccurs="1" name="GuidelineText" type="xs:string"/>
<xs:element minOccurs="0" maxOccurs="1" name="GuidelineId" type="xs:string"/>
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<GetGuidelineForProcedureResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SuccessStatus>1</SuccessStatus>
<GuidelineText>Some text describing guideline for procedure</GuidelineText>
<GuidelineId>f309bde1-c45d-4f59-812d-791c80a68be9</GuidelineId>
</GetGuidelineForProcedureResponse>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| SuccessStatus |
References catalogue SuccessStatus |
YES |
| ErrorList |
List of errors |
If SuccessStatus is set to Fail |
| GuidelineText |
Text of the guideline for medical procedure |
If exists |
| GuidelineId |
Id of the guideline for medical procedure |
If exists |
4.3 SubmitReferral
Method used to Create, Update, or Cancel a referral. The Action field is used to define the desired operation.
Depending on the selected Action, the following parameters are mandatory:
- Create:
ReferralUniqueIdentifier, ReasonForDuplicateProcedure (if this referral is a duplicate), GuidelineIdentifier (if exists)
- Update:
ReferralUniqueIdentifier, UpdateReason
- Cancel:
ReferralUniqueIdentifier, CancelledBy, CancellationReasonCode, CancellationReasonDescription (mandatory for reason Ostalo)
If an e-referral is issued for a paper referral, it is mandatory to provide both AdminNurseIdentifier and PaperReferralIdentifier.
With the request it is mandatory to send the signed referral document in XML format.
Please refer to documents 'eReferral XML', 'eReferral XSD', 'eReferral-Xpaths'.
string SubmitReferral(int version, string request, string referral, byte[] signature)
SubmitReferralRequest
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="SubmitReferralRequest">
<xs:complexType>
<xs:all>
<xs:element name="ApiKey" type="NonEmptyString" />
<xs:element name="ReferralUniqueIdentifier" type="ReferralUidType" />
<xs:element name="HealthcareProviderIndex" type="BPIType" />
<xs:element name="HealthcareProviderSpecificIndex" type="BPIspecificType" minOccurs="0" />
<xs:element name="Action" type="ReferralActionType" />
<xs:element name="ReasonForDuplicateProcedure" type="xs:string" minOccurs="0" />
<xs:element name="GuidelineIdentifier" type="xs:string" minOccurs="0" />
<xs:element name="AdminNurseIdentifier" type="xs:string" minOccurs="0" />
<xs:element name="PaperReferralIdentifier" type="xs:string" minOccurs="0" />
<xs:element name="UpdateReason" type="xs:string" minOccurs="0" />
<xs:element name="CancelledBy" type="xs:string" minOccurs="0" />
<xs:element name="CancellationReasonCode" type="ReferralCancellationReasonType" minOccurs="0" />
<xs:element name="CancellationReasonDescription" type="xs:string" minOccurs="0" />
<xs:element name="ChronicConditionCode" type="xs:string" minOccurs="0" />
<xs:element name="AwareOfPatientAge" type="xs:boolean" minOccurs="0" nillable="true"/>
<xs:element name="ReasonForChangingUrgencyType" type="xs:string" minOccurs="0" />
<xs:element name="DocumentType" type="DocumentType" minOccurs="0"/>
<xs:element name="PaperReferralSubmitionDateTime" type="xs:dateTime" minOccurs="0"/>
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<SubmitReferralRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ApiKey>Test</ApiKey>
<ReferralUniqueIdentifier>1234567891234</ReferralUniqueIdentifier>
<HealthcareProviderIndex>10000</HealthcareProviderIndex>
<Action>1</Action>
</SubmitReferralRequest>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| ApiKey |
Application key of the application making the request |
YES |
| ReferralUniqueIdentifier |
Referral unique identifier |
Look method description |
| HealthcareProviderIndex |
Medical facility code (BPI) |
Look method description |
| HealthcareProviderSpecificIndex |
Medical facility specific code (Used when multiple software vendors maintain the IS of the same facility) |
Look method description |
| Action |
References catalogue ReferralActionType |
Look method description |
| ReasonForDuplicateProcedure |
Reason for creating another referral for given procedure while another referral is active |
Look method description |
| GuidelineIdentifier |
Identifier of the guideline for given medical procedure |
Look method description |
| AdminNurseIdentifier |
Identifier of the nurse administrator creating the referral |
Look method description |
| PaperReferralIdentifier |
Identifier of the paper referral nurse is creating this referral for |
Look method description |
| UpdateReason |
Update reason |
Look method description |
| CancelledBy |
Unique identifier (BPI) of the person which cancelled the referral |
Look method description |
| CancellationReasonCode |
Cancellation reason code (References catalogue ReferralCancellationReasonType) |
Look method description |
| CancellationReasonDescription |
Additional notes about the cancellation |
Look method description |
| ChronicConditionCode |
Chronic conditions used when creating permanent referrals (References catalogue ChronicConditionesTypes) |
Look method description |
| AwareOfPatientAge |
True or False. Indicates if doctor was aware of the patients age and medical procedure age ordering limitations |
Look method description |
| ReasonForChangingUrgencyType |
Description of reason what is the cause for changing urgency type |
NO, but it is mandatory when user is changing urgency type |
| DocumentTypeCode |
Type of document (Referral or Work order) (References catalogue DocumentType) |
NO (if is empty then is Referral) |
| PaperReferralSubmitionDateTime |
Datetime when doctor who makes eReferral received paper referral |
NO, but mandatory when PaperReferralIdentifier exists |
SubmitReferralResponse
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="SubmitReferralResponse">
<xs:complexType>
<xs:all>
<xs:element name="SuccessStatus" type="SuccessStatusType" />
<xs:element name="ErrorList" type="ErrorListType" minOccurs="0"/>
<xs:element name="ReferralUniqueIdentifier" type="ReferralUidType" minOccurs="0"/>
<xs:element name="ReferralCreationDatetime" type="xs:dateTime" minOccurs="0"/>
<xs:element name="XdsDocumentHandleUniqueId" type="xs:string" minOccurs="0"/>
<xs:element name="XdsDocumentHandleRepositoryUniqueId" type="xs:string" minOccurs="0"/>
<xs:element name="XdsDocumentHandleId" type="xs:string" minOccurs="0"/>
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<SubmitReferralResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SuccessStatus>1</SuccessStatus>
<ReferralUniqueIdentifier>1234567890123</ReferralUniqueIdentifier>
<XdsDocumentHandleUniqueId />
<XdsDocumentHandleRepositoryUniqueId />
<XdsDocumentHandleId />
</SubmitReferralResponse>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| SuccessStatus |
References catalogue SuccessStatus |
YES |
| ErrorList |
List of errors |
If SuccessStatus is set to Fail |
| ReferralUniqueIdentifier |
Referral unique identifier |
If SuccessStatus is set to Success |
| ReferralCreationDatetime |
Date and time when referral was created in central system |
For Create action |
| XdsDocumentHandleUniqueId |
Unique handle id of the document in the storage system |
If SuccessStatus is set to Success |
| XdsDocumentHandleRepositoryUniqueId |
Unique handle id of the document repository in the storage system |
If SuccessStatus is set to Success |
| XdsDocumentHandleId |
Handle id of the document in the storage system |
If SuccessStatus is set to Success |
4.4 GetReferral
Method used to get details about one referral. Response will include referral XML.
string GetReferral(int version, string request, out string referralXml)
GetReferralRequest
XSD Schema:
<?xml version=“1.0“ encoding=“utf-8“?>
<xs:schema xmlns:xs=“http://www.w3.org/2001/XMLSchema“>
<xs:include schemaLocation=“Common.xsd“ />
<xs:element name=“GetReferralRequest“>
<xs:complexType>
<xs:all>
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“ApiKey“ type=“NonEmptyString“ />
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“HealthcareProviderIndex“ type=“BPIType“ />
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“ReferralUniqueIdentifier“ type=“ReferralUidType“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“HealthcareProviderSpecificIndex“ type=“BPIspecificType“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“PatientInsuranceIdentifier“ type=“PatientInsIdType“ />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version=“1.0“ encoding=“utf-8“?>
<GetReferralRequest xmlns:xsi=“http://www.w3.org/2001/XMLSchema-instance“ xmlns:xsd=“http://www.w3.org/2001/XMLSchema“>
<ApiKey>1d75ed19-1499-47ce-92cf-2377d01f9ade</ApiKey>
<HealthcareProviderIndex>12681</HealthcareProviderIndex>
<ReferralUniqueIdentifier>2014013100001</ReferralUniqueIdentifier>
<PatientInsuranceIdentifier>123456789</PatientInsuranceIdentifier>
</GetReferralRequest>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| ApiKey |
Application key of the application making the request |
YES |
| HealthcareProviderIndex |
Medical facility code (BPI) |
YES |
| HealthcareProviderSpecificIndex |
Medical facility specific code (Used when multiple software vendors maintain the IS of the same facility) |
Only if exists |
| ReferralUniqueIdentifier |
Referral unique identifier |
YES |
| PatientInsuranceIdentifier |
Patient insurance identifier (KZZ) |
NO |
GetReferralResponse
XSD Schema:
<?xml version=“1.0“ encoding=“utf-8“?>
<xs:schema xmlns:xs=“http://www.w3.org/2001/XMLSchema“>
<xs:include schemaLocation=“Common.xsd“ />
<xs:element name=“GetReferralResponse“>
<xs:complexType>
<xs:all>
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“SuccessStatus“ type=“SuccessStatusType“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“ErrorList“ type=“ErrorListType“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“FirstAdmissionDate“ type=“xs:dateTime“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“DateValidTo“ type=“xs:dateTime“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“LatestMedicalProcedure“ type=“MedicalProcedureCodeType“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“ReferralStatusCode“ type=“ReferralStatusType“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“CancelReferralCode“ type=“ReferralCancellationReasonType“/>
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“CancelReferralDescription“ type=“xs:string“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“CancelledBy“ type=“xs:string“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“ControlNotNeeded“ type=“xs:boolean“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“OldReferralUniqueIdentifier“ type=“ReferralUidType“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“AllowOrderingPatient“ type=“xs:boolean“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“DateOrderingDeadlinePatient“ type=“xs: dateTime“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“AllowOrderingFacility“ type=“xs:boolean“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“DateOrderingDeadlineFacility“ type=“xs: dateTime“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“CancellationDateTime“ type=“xs: dateTime“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“ReasonForChangingUrgencyType“ type=“xs:string“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“UrgencyType“ type=“UrgencyTypeForRefType“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“DocumentTypeCode“ type=“DocumentType“ nillable=“true“ />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version=“1.0“ encoding=“utf-8“?>
<GetReferralResponse xmlns:xsi=“http://www.w3.org/2001/XMLSchema-instance“ xmlns:xsd=“http://www.w3.org/2001/XMLSchema“>
<SuccessStatus>1</SuccessStatus>
<FirstAdmissionDate>2019-03-06T00:00:00</FirstAdmissionDate>
<DateValidTo>2019-03-11T00:00:00</DateValidTo>
<LatestMedicalProcedure>1020</LatestMedicalProcedure>
<ReferralStatusCode>3</ReferralStatusCode>
<CancelReferralCode>4</CancelReferralCode>
<CancelReferralDescription>Doslo je do greske</CancelReferralDescription>
<CancelledBy>ana</CancelledBy>
<ControlNotNeeded>true</ControlNotNeeded>
<OldReferralUniqueIdentifier>2014013100001</OldReferralUniqueIdentifier>
<AllowOrderingPatient>true</AllowOrderingPatient>
<DateOrderingDeadlinePatient>2022-10-26T00:00:00</DateOrderingDeadlinePatient>
<AllowOrderingFacility>true</AllowOrderingFacility>
<DateOrderingDeadlineFacility>2022-10-26T00:00:00</DateOrderingDeadlineFacility>
<CancellationDateTime>2019-03-01T00:00:00</CancellationDateTime>
<ReasonForChangingUrgencyType>test</ReasonForChangingUrgencyType>
<UrgencyType>3</UrgencyType>
<DocumentTypeCode>0</DocumentTypeCode>
</GetReferralResponse>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| SuccessStatus |
References catalogue SuccessStatus |
YES |
| FirstAdmissionDate |
Date of the first admission |
Only if exists |
| DateValidTo |
Date till when the referral is valid |
If applicable |
| LatestMedicalProcedure |
Latest valid medical procedure for referral |
YES |
| ReferralStatusCode |
Referral status (References catalogue ReferralStatusType) |
YES |
| CancelReferralCode |
Referral cancellation reason (References catalogue ReferralCancellationReasonType) |
Only if referral is cancelled |
| CancelReferralDescription |
Additional notes regarding the cancellation |
Only if exists and referral is cancelled |
| CancelledBy |
Unique identifier (BPI) of the person which cancelled the referral |
Only if referral is cancelled |
| ControlNotNeeded |
Flag to indicate that the patient does not need any further control exams |
Only if exists |
| OldReferralUniqueIdentifier |
Previous referral unique identifier |
Only if exists |
| AllowOrderingPatient |
Flag to indicate that the patient can make appointment |
Only if exists |
| DateOrderingDeadlinePatient |
DeadlineDate till patient can make appointment |
Only if AllowOrderingPatient is true |
| AllowOrderingFacility |
Flag to indicate that the hospital can make appointment |
Only if exists |
| DateOrderingDeadlineFacility |
DeadlineDate till hospital can make appointment |
Only if AllowOrderingFacility is true |
| ErrorList |
List of errors |
If SuccessStatus is set to Fail |
| CancellationDateTime |
Date and time when the referral is cancelled |
Only if referral is cancelled |
| ReasonForChangingUrgencyType |
Reason for changing starting urgency type to new urgency type of referral |
Only if starting urgency type was changed |
| UrgencyType |
References catalogue UrgencyCodeType |
NO |
| DocumentTypeCode |
Type of document (Referral or Work order) (References catalogue DocumentType) |
NO (if is empty then is Referral) |
4.5 GetReferralList
Method used to get more referrals. It is mandatory to provide the patient insurance identifier (KZZ).
Other parameters are optional and are used to narrow the search.
GetReferralListRequest
XSD Schema:
<?xml version=“1.0“ encoding=“utf-8“?>
<xs:schema xmlns:xs=“http://www.w3.org/2001/XMLSchema“>
<xs:include schemaLocation=“Common.xsd“ />
<xs:complexType name=“ArrayOfStatuses“>
<xs:sequence>
<xs:element minOccurs=“0“ maxOccurs=“unbounded“ name=“ReferralStatusType“ type=“ReferralStatusType“ />
</xs:sequence>
</xs:complexType>
<xs:element name=“GetReferralListRequest“>
<xs:complexType>
<xs:all>
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“PatientInsuranceIdentifier“ type=“PatientInsIdType“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“RequestorDocIdentifier“ type=“xs:string“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“DatetimeFrom“ type=“xs:dateTime“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“DatetimeTo“ type=“xs:dateTime“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“Statuses“ type=“ArrayOfStatuses“ />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version=“1.0“ encoding=“utf-8“?>
<GetReferralListRequest xmlns:xsi=“http://www.w3.org/2001/XMLSchema-instance“ xmlns:xsd=“http://www.w3.org/2001/XMLSchema“>
<PatientInsuranceIdentifier>123456789</PatientInsuranceIdentifier>
<RequestorDocIdentifier>98826622</RequestorDocIdentifier>
<DatetimeFrom>2013-03-24T00:00:00</DatetimeFrom>
<DatetimeTo>2014-01-10T00:00:00</DatetimeTo>
<Statuses>
<ReferralStatusType>1</ReferralStatusType>
<ReferralStatusType>4</ReferralStatusType>
</Statuses>
</GetReferralListRequest>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| PatientInsuranceIdentifier |
Patient insurance identifier (KZZ) |
YES |
| RequestorDocIdentifier |
Unique identifier (BPI) of the doctor which created the referral |
NO |
| DatetimeFrom |
Get all referrals from this date |
NO |
| DatetimeTo |
Get all referrals to this date |
NO |
| Statuses |
List of referral statuses |
NO |
GetReferralListResponse
XSD Schema:
<?xml version=“1.0“ encoding=“utf-8“?>
<xs:schema xmlns:xs=“http://www.w3.org/2001/XMLSchema“>
<xs:include schemaLocation=“Common.xsd“ />
<xs:element name=“ReferralSummary“>
<xs:complexType>
<xs:all>
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“ReferralUniqueIdentifier“ type=“ReferralUidType“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“OldReferralUniqueIdentifier“ type=“ReferralUidType“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“PatientUniqueIdentifier“ type=“PatientUIdType“ />
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“PatientInsuranceIdentifier“ type=“PatientInsIdType“ />
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“RequestorDocIdentifier“ type=“xs:string“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“RequestorDocName“ type=“xs:string“ />
<xs:element minOccurs=“0 “ maxOccurs=“1“ name=“RequestorDocSurname“ type=“xs:string“ />
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“ReferralCreationDatetime“ type=“xs:dateTime“ />
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“ReferralStatusCode“ type=“ReferralStatusType“ />
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“MedicalDiagnosis“ type=“xs:string“ />
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“MedicalProcedure“ type=“MedicalProcedureCodeType“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“LastAdmissionFacilityCode“ type=“BPIType“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“ LastAdmissionFacilitySpecificCode“ type=“BPIspecificType“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“EarliestControlDate“ type=“xs:dateTime“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“DateValidFrom“ type=“xs:dateTime“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“DateValidTo“ type=“xs:dateTime“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“UrgencyType“ type=“UrgencyTypeForRefType“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“CancelReferralCode“ type=“ReferralCancellationReasonType“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“CancelReferralDescription“ type=“xs:string“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“CancelledBy“ type=“xs:string“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“ControlNotNeeded“ type=“xs:boolean“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“LastAppointmentFacilityName“ type=“xs:string“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“LastAppointmentFacilityCode“ type=“BPIType“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“ LastAppointmentFacilitySpecificCode“ type=“BPIspecificType“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“ AllowOrderingFacility“ type=“xs:boolean“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“DateOrderingDeadlineFacility“ type=“xs:dateTime“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“ AllowOrderingPatient“ type=“xs:boolean“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“DateOrderingDeadlinePatient“ type=“xs:dateTime“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“CancellationDateTime“ type=“xs:dateTime“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“ReasonForChangingUrgencyType“ type=“xs:string“ />
<xs:element minOccurs="0" maxOccurs="1" name="DocumentTypeCode" type="DocumentType" nillable ="true" />
</xs:all>
</xs:complexType>
</xs:element>
<xs:element name=“Referrals“>
<xs:complexType>
<xs:sequence>
<xs:element minOccurs=“0“ maxOccurs=“unbounded“ ref=“ReferralSummary“ />
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name=“GetReferralListResponse“>
<xs:complexType>
<xs:all>
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“SuccessStatus“ type=“SuccessStatusType“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“ErrorList“ type=“ErrorListType“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ ref=“Referrals“ />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version=“1.0“ encoding=“utf-8“?>
<GetReferralListResponse xmlns:xsi=“http://www.w3.org/2001/XMLSchema-instance“ xmlns:xsd=“http://www.w3.org/2001/XMLSchema“>
<SuccessStatus>1</SuccessStatus>
<Referrals>
<ReferralSummary>
<ReferralUniqueIdentifier>0214574125981</ReferralUniqueIdentifier>
<OldReferralUniqueIdentifier>0214574125111</OldReferralUniqueIdentifier>
<PatientUniqueIdentifier>1234567890123</PatientUniqueIdentifier>
<PatientInsuranceIdentifier>096000154</PatientInsuranceIdentifier>
<RequestorDocIdentifier>08087</RequestorDocIdentifier>
<RequestorDocName>Primarni</RequestorDocName>
<RequestorDocSurname>Doktor</RequestorDocSurname>
<ReferralCreationDatetime>2019-01-03T00:00:00</ReferralCreationDatetime>
<ReferralStatusCode>3</ReferralStatusCode>
<MedicalDiagnosis>A5014</MedicalDiagnosis>
<MedicalProcedure>1020K</MedicalProcedure>
<LastAdmissionFacility>05412</LastAdmissionFacility>
<EarliestControlDate>2019-06-20T00:00:00</EarliestControlDate>
<DateValidFrom>0001-01-01T00:00:00</DateValidFrom>
<DateValidTo>2020-12-03T00:00:00</DateValidTo>
<UrgencyType>1</UrgencyType>
<CancelReferralCode>4</CancelReferralCode>
<CancelReferralDescription>CancelReferralDescription</CancelReferralDescription>
<CancelledBy>Sestra administator</CancelledBy>
<ControlNotNeeded>false</ControlNotNeeded>
<AllowOrderingFacility>true</AllowOrderingFacility>
<AllowOrderingPatient>true</AllowOrderingPatient>
<DateOrderingDeadlineFacility>2024-03-22T00:00:00</DateOrderingDeadlineFacility>
<DateOrderingDeadlinePatient>2024-01-17T00:00:00</DateOrderingDeadlinePatient>
< DocumentTypeCode>0</DocumentTypeCode>
</ReferralSummary>
<ReferralSummary>
<ReferralUniqueIdentifier>0214574125982</ReferralUniqueIdentifier>
<OldReferralUniqueIdentifier>0214574125222</OldReferralUniqueIdentifier>
<PatientUniqueIdentifier>1234567890123</PatientUniqueIdentifier>
<PatientInsuranceIdentifier>096000154</PatientInsuranceIdentifier>
<RequestorDocIdentifier>08087</RequestorDocIdentifier>
<RequestorDocName>Primarni</RequestorDocName>
<RequestorDocSurname>Doktor</RequestorDocSurname>
<ReferralCreationDatetime>2019-01-03T00:00:00</ReferralCreationDatetime>
<ReferralStatusCode>3</ReferralStatusCode>
<MedicalDiagnosis>A5014</MedicalDiagnosis>
<MedicalProcedure>1020K</MedicalProcedure>
<LastAdmissionFacilityCode>05412</LastAdmissionFacilityCode>
<LastAdmissionFacilitySpecificCode>05412A</LastAdmissionFacilitySpecificCode>
<EarliestControlDate>2019-06-20T00:00:00</EarliestControlDate>
<DateValidFrom>0001-01-01T00:00:00</DateValidFrom>
<DateValidTo>2020-12-03T00:00:00</DateValidTo>
<UrgencyType>1</UrgencyType>
<CancelReferralCode>4</CancelReferralCode>
<CancelReferralDescription>CancelReferralDescription</CancelReferralDescription>
<CancelledBy>Sestra administator</CancelledBy>
<ControlNotNeeded>false</ControlNotNeeded>
<LastAppointmentFacilityName>IN2 test</LastAppointmentFacilityName>
<LastAppointmentFacilityCode>05412</LastAppointmentFacilityCode>
<LastAppointmentFacilitySpecificCode>05412A </LastAppointmentFacilitySpecificCode>
<AllowOrderingFacility>false</AllowOrderingFacility>
<AllowOrderingPatient>false</AllowOrderingPatient>
< CancellationDateTime>2019-03-01T00:00:00</>
</ReferralSummary>
<ReferralSummary>
<ReferralUniqueIdentifier>0214574125983</ReferralUniqueIdentifier>
<OldReferralUniqueIdentifier>0214574125333</OldReferralUniqueIdentifier>
<PatientUniqueIdentifier>1234567890123</PatientUniqueIdentifier>
<PatientInsuranceIdentifier>096000154</PatientInsuranceIdentifier>
<RequestorDocIdentifier>08087</RequestorDocIdentifier>
<RequestorDocName>Primarni</RequestorDocName>
<RequestorDocSurname>Doktor</RequestorDocSurname>
<ReferralCreationDatetime>2019-01-03T00:00:00</ReferralCreationDatetime>
<ReferralStatusCode>3</ReferralStatusCode>
<MedicalDiagnosis>A5014</MedicalDiagnosis>
<MedicalProcedure>1020K</MedicalProcedure>
<LastAdmissionFacility>05412</LastAdmissionFacility>
<EarliestControlDate>2019-06-20T00:00:00</EarliestControlDate>
<DateValidFrom>0001-01-01T00:00:00</DateValidFrom>
<DateValidTo>2020-12-03T00:00:00</DateValidTo>
<UrgencyType>1</UrgencyType>
<CancelReferralCode>4</CancelReferralCode>
<CancelReferralDescription>CancelReferralDescription</CancelReferralDescription>
<CancelledBy>Sestra administator</CancelledBy>
<ControlNotNeeded>false</ControlNotNeeded>
<AllowOrderingFacility>true</AllowOrderingFacility>
<AllowOrderingPatient>false</AllowOrderingPatient>
<DateOrderingDeadlineFacility>2024-01-02T00:00:00</DateOrderingDeadlineFacility>
</ReferralSummary>
</Referrals>
</GetReferralListResponse>
Element Descriptions:
Common:
| Element name |
Element description |
Mandatory |
| SuccessStatus |
References catalogue SuccessStatus |
YES |
| ErrorList |
List of errors |
If SuccessStatus is set to Fail |
| Referrals |
Referrals list |
If any referral exists |
Referral details:
| Element name |
Element description |
Mandatory |
| ReferralUniqueIdentifier |
Referral unique identifier |
YES |
| OldReferralUniqueIdentifier |
Referral unique identifier of the old referral |
NO |
| PatientUniqueIdentifier |
Unique identifier of the patient (EMŠO) |
NO |
| PatientInsuranceIdentifier |
Insurance identifier of the patient (KZZ) |
YES |
| RequestorDocIdentifier |
Unique identifier (BPI) of the doctor which created the referral |
YES |
| RequestorDocName |
First name of the doctor which created the referral |
YES |
| RequestorDocSurname |
Last name of the doctor which created the referral |
YES |
| ReferralCreationDatetime |
Referral creation date and time |
YES |
| ReferralStatusCode |
References catalogue ReferralStatusType |
YES |
| MedicalDiagnosis |
Medical diagnosis unique identifier |
YES |
| MedicalProcedure |
Medical procedure unique identifier (VZS) |
YES |
| LastAdmissionFacilityCode |
Facility code in which the last exam took place |
NO |
| LastAdmissionFacilitySpecificCode |
Facility specific code in which the last exam took place |
NO |
| EarliestControlDate |
Earliest date of the next control exam for referral |
NO |
| DateValidFrom |
Date from which referral validity is calculated (i.e. date of first admission, if any) |
If applicable |
| DateValidTo |
Date till when the referral is valid (if applicable) |
If applicable |
| UrgencyType |
References catalogue UrgencyCodeType |
YES |
| CancelReferralCode |
References catalogue ReferralCancellationReasonType |
Only if referral is cancelled |
| CancelReferralDescription |
Additional notes about the referral cancellation |
If exists |
| CancelledBy |
Unique identifier (BPI) of the person which cancelled the referral |
Only if referral is cancelled |
| ControlNotNeeded |
Flag to indicate that the patient does not need any further control exams |
If exists |
| AllowOrderingFacility |
Flag to indicate that the hospital can make appointment |
If exists |
| DateOrderingDeadlineFacility |
The deadline for ordering for hospitals |
If exists |
| AllowOrderingPatient |
Flag to indicate that the patient can make appointment |
If exists |
| DateOrderingDeadlinePatient |
The deadline for ordering for patients |
If exists |
| LastAppointmentFacilityName |
Facility where the last active appointment was placed |
If exists |
| LastAppointmentFacilityCode |
Facility code where the last active appointment was placed |
If exists |
| LastAppointmentFacilitySpecificCode |
Facility specific code where the last active appointment was placed |
If exists |
| CancellationDateTime |
Date and time when the referral is cancelled |
Only if referral is cancelled |
| ReasonForChangingUrgencyType |
Reason for changing starting urgency type to new urgency type of referral |
Only if starting urgency type was changed |
| DocumentTypeCode |
Type of document (Referral or Work order) (References catalogue DocumentType) |
NO (if is empty then is Referral) |
4.6 CreateReferralAttachment
Method which adds an attachment to the referral.
CreateReferralAttachmentRequest
XSD Schema:
<?xml version=“1.0“ encoding=“utf-8“?>
<xs:schema xmlns:xs=“http://www.w3.org/2001/XMLSchema“>
<xs:include schemaLocation=“Common.xsd“ />
<xs:element name=“CreateReferralAttachmentRequest“>
<xs:complexType>
<xs:all>
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“ApiKey“ type=“NonEmptyString“ />
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“HealthcareProviderIndex“ type=“BPIType“ />
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“ReferralUniqueIdentifier“ type=“ReferralUidType“ />
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“AttachmentContent“ type=“xs:base64Binary“ />
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“CreationDateTime“ type=“xs:dateTime“ />
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“MetadataClassCode“ type=“NonEmptyString“ />
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“MetadataTypeCode“ type=“NonEmptyString“ />
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“DocumentTitle“ type=“NonEmptyString“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“HealthcareProviderSpecificIndex“ type=“BPIspecificType“ />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version=“1.0“ encoding=“utf-8“?>
<CreateReferralAttachmentRequest xmlns:xsi=“http://www.w3.org/2001/XMLSchema-instance“ xmlns:xsd=“http://www.w3.org/2001/XMLSchema“>
<ApiKey>1d75ed19-1499-47ce-92cf-2377d01f9ade</ApiKey>
<HealthcareProviderIndex>12681</HealthcareProviderIndex>
<ReferralUniqueIdentifier>2017062900001</ReferralUniqueIdentifier>
<AttachmentContent>FCAgICAgIA==</AttachmentContent>
<CreationDateTime>2020-01-01T00:00:00</CreationDateTime>
<MetadataClassCode>code</MetadataClassCode>
<MetadataTypeCode>type</MetadataTypeCode>
<DocumentTitle>title.pdf</DocumentTitle>
<HealthcareProviderSpecificIndex>12681A</HealthcareProviderSpecificIndex>
</CreateReferralAttachmentRequest>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| ApiKey |
Application key of the application making the request |
YES |
| HealthcareProviderIndex |
Medical facility code (BPI) |
YES |
| ReferralUniqueIdentifier |
Referral unique identifier |
YES |
| AttachmentContent |
Binary content of the attachment |
YES |
| CreationDateTime |
Date and time of creating the attachment |
YES |
| MetadataClassCode |
References catalogue Class code |
YES |
| MetadataTypeCode |
References catalogue Type code (attachments) |
YES |
| DocumentTitle |
Title of the attachment |
YES |
| HealthcareProviderSpecificIndex |
Medical facility specific code (Used when multiple software vendors maintain the IS of the same facility) |
Only if exists |
CreateReferralAttachmentResponse
XSD Schema:
<?xml version=“1.0“ encoding=“utf-8“?>
<xs:schema xmlns:xs=“http://www.w3.org/2001/XMLSchema“>
<xs:include schemaLocation=“Common.xsd“ />
<xs:element name=“CreateReferralAttachmentResponse“>
<xs:complexType>
<xs:all>
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“ErrorList“ type=“ErrorListType“ />
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“SuccessStatus“ type=“SuccessStatusType“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“XdsDocumentHandleUniqueId“ type=“xs:string“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“XdsDocumentHandleRepositoryUniqueId“ type=“xs:string“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“XdsDocumentHandleId“ type=“xs:string“ />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<CreateReferralAttachmentResponse xmlns:xsi=“http://www.w3.org/2001/XMLSchema-instance“ xmlns:xsd=“http://www.w3.org/2001/XMLSchema“>
<SuccessStatus>1</SuccessStatus>
<XdsDocumentHandleUniqueId>2.16.840.1.113883.3.711.2.1.4.4.161006989058216270188361</XdsDocumentHandleUniqueId>
<XdsDocumentHandleRepositoryUniqueId>2.16.840.1.113883.3.711.2.1.4.5.12681</XdsDocumentHandleRepositoryUniqueId>
<XdsDocumentHandleId>urn:uuid:bbd27b00-0c3f-44bd-9217-6e2ab66e0abc</XdsDocumentHandleId>
</CreateReferralAttachmentResponse>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| SuccessStatus |
References catalogue SuccessStatus |
YES |
| ErrorList |
List of errors |
If SuccessStatus is set to Fail |
| XdsDocumentHandleUniqueId |
Unique handle id of the document in the storage system |
If SuccessStatus is set to Success |
| XdsDocumentHandleRepositoryUniqueId |
Unique handle id of the document repository in the storage system |
If SuccessStatus is set to Success |
| XdsDocumentHandleId |
Handle id of the document in the storage system |
If SuccessStatus is set to Success |
4.7 UpdateReferralAttachment
Method which updates an attachment to the referral.
UpdateReferralAttachmentRequest
XSD Schema:
<?xml version=“1.0“ encoding=“utf-8“?>
<xs:schema xmlns:xs=“http://www.w3.org/2001/XMLSchema“>
<xs:include schemaLocation=“Common.xsd“ />
<xs:element name=“UpdateReferralAttachmentRequest“>
<xs:complexType>
<xs:all>
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“ApiKey“ type=“NonEmptyString“ />
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“HealthcareProviderIndex“ type=“BPIType“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“HealthcareProviderSpecificIndex“ type=“BPIspecificType“ />
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“ReferralUniqueIdentifier“ type=“ReferralUidType“ />
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“NewAttachmentContent“ type=“xs:base64Binary“ />
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“NewCreationDateTime“ type=“xs:dateTime“ />
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“NewMetadataClassCode“>
<xs:simpleType>
<xs:restriction base=“xs:string“>
<xs:maxLength value=“10“ />
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“NewMetadataTypeCode“>
<xs:simpleType>
<xs:restriction base=“xs:string“>
<xs:maxLength value=“100“ />
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“NewDocumentTitle“>
<xs:simpleType>
<xs:restriction base=“xs:string“>
<xs:maxLength value=“1000“ />
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“Reason“ type=“NonEmptyString“ />
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“OldAttachmentHandleId“ type=“NonEmptyString“ />
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“OldAttachmentHandleUniqueId“ type=“NonEmptyString“ />
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“OldAttachmentHandleRepositoryUniqueId“ type=“NonEmptyString“ />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version=“1.0“ encoding=“utf-8“?>
<UpdateReferralAttachmentRequest xmlns:xsi=“http://www.w3.org/2001/XMLSchema-instance“ xmlns:xsd=“http://www.w3.org/2001/XMLSchema“>
<ApiKey>1d75ed19-1499-47ce-92cf-2377d01f9ade</ApiKey>
<HealthcareProviderIndex>12681</HealthcareProviderIndex>
<ReferralUniqueIdentifier>2014012500040</ReferralUniqueIdentifier>
<NewAttachmentContent>Content</NewAttachmentContent>
<NewCreationDateTime>2014-01-30T00:00:00</NewCreationDateTime>
<NewMetadataClassCode>3</NewMetadataClassCode>
<NewMetadataTypeCode>51845-6</NewMetadataTypeCode>
<NewDocumentTitle>Update attachment</NewDocumentTitle>
<Reason>Pogreška u prethodnom dokumentu</Reason>
<OldAttachmentHandleId>urn:uuid:bbd27b00-0c3f-44bd-9217-6e2ab66e0abc</OldAttachmentHandleId>
<OldAttachmentHandleUniqueId>2.16.840.1.113883.3.711.2.1.4.4.161006989058216270188361</OldAttachmentHandleUniqueId>
<OldAttachmentHandleRepositoryUniqueId>2.16.840.1.113883.3.711.2.1.4.5.12681</OldAttachmentHandleRepositoryUniqueId>
</UpdateReferralAttachmentRequest>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| ApiKey |
Application key of the application making the request |
YES |
| HealthcareProviderIndex |
Medical facility code (BPI) |
YES |
| HealthcareProviderSpecificIndex |
Medical facility specific code (Used when multiple software vendors maintain the IS of the same facility) |
Only if exists |
| ReferralUniqueIdentifier |
Referral unique identifier |
YES |
| NewAttachmentContent |
Binary content of the updated attachment |
YES |
| NewCreationDateTime |
Date and time of updating the attachment |
YES |
| NewMetadataClassCode |
Code of the metadata class of the attachment |
YES |
| NewMetadataTypeCode |
Code of the metadata type of the attachment |
YES |
| NewDocumentTitle |
Title of the attachment |
YES |
| Reason |
Reason for updating the attachment |
YES |
| OldAttachmentHandleId |
Id of the handle for the old attachment in the storage system |
YES |
| OldAttachmentHandleUniqueId |
Unique id of the handle for the old attachment in the storage system |
YES |
| OldAttachmentHandleRepositoryUniqueId |
Repository unique id of the handle for the old attachment in the storage system |
YES |
UpdateReferralAttachmentResponse
XSD Schema:
<?xml version=“1.0“ encoding=“utf-8“?>
<xs:schema xmlns:xs=“http://www.w3.org/2001/XMLSchema“>
<xs:include schemaLocation=“Common.xsd“ />
<xs:element name=“UpdateReferralAttachmentResponse“>
<xs:complexType>
<xs:all>
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“SuccessStatus“ type=“SuccessStatusType“/>
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“ErrorList“ type=“ErrorListType“/>
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“XdsDocumentHandleUniqueId“ type=“xs:string“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“XdsDocumentHandleRepositoryUniqueId“ type=“xs:string“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“XdsDocumentHandleId“ type=“xs:string“ />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version=“1.0“ encoding=“utf-8“?>
<UpdateReferralAttachmentResponse xmlns:xsi=“http://www.w3.org/2001/XMLSchema-instance“ xmlns:xsd=“http://www.w3.org/2001/XMLSchema“>
<SuccessStatus>1</SuccessStatus>
<XdsDocumentHandleUniqueId>2.16.840.1.113883.3.711.2.1.4.4.161006989058216270188361</XdsDocumentHandleUniqueId> <XdsDocumentHandleRepositoryUniqueId>2.16.840.1.113883.3.711.2.1.4.5.12681</XdsDocumentHandleRepositoryUniqueId>
<XdsDocumentHandleId>urn:uuid:bbd27b00-0c3f-44bd-9217-6e2ab66e0abc</XdsDocumentHandleId>
</UpdateReferralAttachmentResponse>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| SuccessStatus |
References catalogue SuccessStatus |
YES |
| ErrorList |
List of errors |
If SuccessStatus is set to Fail |
| XdsDocumentHandleUniqueId |
Unique handle id of the document in the storage system |
If SuccessStatus is set to Success |
| XdsDocumentHandleRepositoryUniqueId |
Unique handle id of the document repository in the storage system |
If SuccessStatus is set to Success |
| XdsDocumentHandleId |
Handle id of the document in the storage system |
If SuccessStatus is set to Success |
4.8 DeleteReferralAttachment
Method which deletes an attachment.
DeleteReferralAttachmentRequest
XSD Schema:
<?xml version=“1.0“ encoding=“utf-8“?>
<xs:schema xmlns:xs=“http://www.w3.org/2001/XMLSchema“>
<xs:include schemaLocation=“Common.xsd“ />
<xs:element name=“DeleteReferralAttachmentRequest“>
<xs:complexType>
<xs:all>
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“ApiKey“ type=“NonEmptyString“ />
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“HealthcareProviderIndex“ type=“BPIType“ />
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“ReferralUniqueIdentifier“ type=“ReferralUidType“ />
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“AttachmentHandleId“ type=“NonEmptyString“ />
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“AttachmentHandleUniqueId“ type=“NonEmptyString“ />
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“AttachmentHandleRepositoryUniqueId“ type=“NonEmptyString“ />
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“Reason“ type=“NonEmptyString“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“HealthcareProviderSpecificIndex“ type=“BPIspecificType“ />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version=“1.0“ encoding=“utf-8“?>
<DeleteReferralAttachmentRequest xmlns:xsi=“http://www.w3.org/2001/XMLSchema-instance“ xmlns:xsd=“http://www.w3.org/2001/XMLSchema“>
<ApiKey>1d75ed19-1499-47ce-92cf-2377d01f9ade</ApiKey>
<HealthcareProviderIndex>12681</HealthcareProviderIndex>
<ReferralUniqueIdentifier>2014012500040</ReferralUniqueIdentifier>
<AttachmentHandleId>urn:uuid:d19a5dcf-21e8-47a1-8c8f-12088622392b</AttachmentHandleId> <AttachmentHandleUniqueId>2.16.840.1.113883.3.711.2.1.4.4.161675482989745799951257</AttachmentHandleUniqueId>
<AttachmentHandleRepositoryUniqueId>2.16.840.1.113883.3.711.2.1.4.5.12681</AttachmentHandleRepositoryUniqueId>
<Reason>Reason for deletion</Reason>
</DeleteReferralAttachmentRequest>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| ApiKey |
Application key of the application making the request |
YES |
| HealthcareProviderIndex |
Medical facility code (BPI) |
YES |
| ReferralUniqueIdentifier |
Referral unique identifier |
YES |
| AttachmentHandleId |
Id of the handle for the requested attachment in the storage system |
YES |
| AttachmentHandleUniqueId |
Unique id of the handle for the requested attachment in the storage system |
YES |
| AttachmentHandleRepositoryUniqueId |
Repository unique id of the handle for the requested attachment in the storage system |
YES |
| Reason |
Reason for deleting the attachment |
YES |
| HealthcareProviderSpecificIndex |
Medical facility specific code (Used when multiple software vendors maintain the IS of the same facility) |
Only if exists |
DeleteReferralAttachmentResponse
XSD Schema:
<?xml version=“1.0“ encoding=“utf-8“?>
<xs:schema xmlns:xs=“http://www.w3.org/2001/XMLSchema“>
<xs:include schemaLocation=“Common.xsd“ />
<xs:element name=“DeleteReferralAttachmentResponse“>
<xs:complexType>
<xs:all>
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“SuccessStatus“ type=“SuccessStatusType“/>
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“ErrorList“ type=“ErrorListType“/>
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version=“1.0“ encoding=“utf-8“?>
<DeleteReferralAttachmentResponse xmlns:xsi=“http://www.w3.org/2001/XMLSchema-instance“ xmlns:xsd=“http://www.w3.org/2001/XMLSchema“>
<SuccessStatus>1</SuccessStatus>
</DeleteReferralAttachmentResponse>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| SuccessStatus |
References catalogue SuccessStatus |
YES |
| ErrorList |
List of errors |
If SuccessStatus is set to Fail |
4.9 GetReferralAttachment
Method used to get one referral attachment.
GetReferralAttachmentRequest
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="GetReferralAttachmentRequest">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="ApiKey" type="NonEmptyString" />
<xs:element minOccurs="1" maxOccurs="1" name="HealthcareProviderIndex" type="BPIType" />
<xs:element minOccurs="1" maxOccurs="1" name="HandleId" type="NonEmptyString" />
<xs:element minOccurs="1" maxOccurs="1" name="HandleUniqueId" type="NonEmptyString" />
<xs:element minOccurs="1" maxOccurs="1" name="HandleRepositoryUniqueId" type="NonEmptyString" />
<xs:element minOccurs="1" maxOccurs="1" name="ReferralUniqueIdentifier" type="NonEmptyString" />
<xs:element minOccurs="0" maxOccurs="1" name="HealthcareProviderSpecificIndex" type="BPIspecificType" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<GetReferralAttachmentRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ApiKey>test</ApiKey>
<HealthcareProviderIndex>10000</HealthcareProviderIndex>
<HandleId>test</HandleId>
<HandleUniqueId>test</HandleUniqueId>
<HandleRepositoryUniqueId>test</HandleRepositoryUniqueId>
<ReferralUniqueIdentifier>1234567891234</ReferralUniqueIdentifier>
<HealthcareProviderSpecificIndex>10000A</HealthcareProviderSpecificIndex>
</GetReferralAttachmentRequest>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| ApiKey |
Application key of the application making the request |
YES |
| HealthcareProviderIndex |
Medical facility code (BPI) |
YES |
| HandleId |
Id of the handle for the requested attachment in the storage system |
YES |
| HandleUniqueId |
Unique id of the handle for the requested attachment in the storage system |
YES |
| HandleRepositoryUniqueId |
Repository unique id of the handle for the requested attachment in the storage system |
YES |
| ReferralUniqueIdentifier |
Referral unique identifier |
YES |
| HealthcareProviderSpecificIndex |
Medical facility specific code (Used when multiple software vendors maintain the IS of the same facility) |
Only if exists |
GetReferralAttachmentResponse
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="GetReferralAttachmentResponse">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="SuccessStatus" type="SuccessStatusType" />
<xs:element minOccurs="0" maxOccurs="1" name="ErrorList" type="ErrorListType" />
<xs:element minOccurs="0" maxOccurs="1" name="Content" type="xs:base64Binary" />
<xs:element minOccurs="0" maxOccurs="1" name="Type" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="Title" type="xs:string" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<GetReferralAttachmentResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SuccessStatus>1</SuccessStatus>
<Content>4uPg</Content>
<Type>test</Type>
<Title>test</Title>
</GetReferralAttachmentResponse>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| ErrorList |
List of errors |
If SuccessStatus is set to Fail |
| SuccessStatus |
References catalogue SuccessStatus |
YES |
| Content |
Binary content of the attachment |
If SucessStatus is set to Success |
| Type |
Mime type of the attachment content |
If SucessStatus is set to Success |
| Title |
Title of the attachment content |
If SucessStatus is set to Success |
4.10 GetReferralAttachmentList
Method used to get all the attachments for one referral.
GetReferralAttachmentListRequest
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="GetReferralAttachmentListRequest">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="ApiKey" type="NonEmptyString" />
<xs:element minOccurs="1" maxOccurs="1" name="HealthcareProviderIndex" type="BPIType" />
<xs:element minOccurs="1" maxOccurs="1" name="ReferralUniqueIdentifier" type="ReferralUidType" />
<xs:element minOccurs="0" maxOccurs="1" name="HealthcareProviderSpecificIndex" type="BPIspecificType" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<GetReferralAttachmentListRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ApiKey>test</ApiKey>
<HealthcareProviderIndex>10000</HealthcareProviderIndex>
<ReferralUniqueIdentifier>1234567891234</ReferralUniqueIdentifier>
<HealthcareProviderSpecificIndex>10000A</HealthcareProviderSpecificIndex>
</GetReferralAttachmentListRequest>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| ApiKey |
Application key of the application making the request |
YES |
| HealthcareProviderIndex |
Medical facility code (BPI) |
YES |
| ReferralUniqueIdentifier |
Referral unique identifier |
YES |
| HealthcareProviderSpecificIndex |
Medical facility specific code (Used when multiple software vendors maintain the IS of the same facility) |
Only if exists |
GetReferralAttachmentListResponse
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="ReferralAttachmentSummary">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="Title" type="xs:string" />
<xs:element minOccurs="1" maxOccurs="1" name="CreationDateTime" type="xs:dateTime" />
<xs:element minOccurs="1" maxOccurs="1" name="MetadataClassCode" type="NonEmptyString" />
<xs:element minOccurs="1" maxOccurs="1" name="MetadataTypeCode" type="NonEmptyString" />
<xs:element minOccurs="1" maxOccurs="1" name="HealthcareFaciliyTypeCode" type="NonEmptyString" />
<xs:element minOccurs="1" maxOccurs="1" name="PracticeSettingCode" type="NonEmptyString" />
<xs:element minOccurs="1" maxOccurs="1" name="ReferralUniqueIdentifier" type="ReferralUidType" />
<xs:element minOccurs="1" maxOccurs="1" name="HandleId" type="NonEmptyString" />
<xs:element minOccurs="1" maxOccurs="1" name="HandleUniqueId" type="NonEmptyString" />
<xs:element minOccurs="1" maxOccurs="1" name="HandleRepositoryUniqueId" type="NonEmptyString" />
</xs:all>
</xs:complexType>
</xs:element>
<xs:element name="Attachments">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="ReferralAttachmentSummary" />
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="GetReferralAttachmentListResponse">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="SuccessStatus" type="SuccessStatusType" />
<xs:element minOccurs="0" maxOccurs="1" name="ErrorList" type="ErrorListType" />
<xs:element minOccurs="0" maxOccurs="1" ref="Attachments" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<GetReferralAttachmentListResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SuccessStatus>1</SuccessStatus>
<Attachments>
<ReferralAttachmentSummary>
<Title>test</Title>
<CreationDateTime>2019-02-25T14:52:05.3387118+01:00</CreationDateTime>
<MetadataClassCode>test</MetadataClassCode>
<MetadataTypeCode>test</MetadataTypeCode>
<HealthcareFaciliyTypeCode>test</HealthcareFaciliyTypeCode>
<PracticeSettingCode>test</PracticeSettingCode>
<ReferralUniqueIdentifier>1234567891234</ReferralUniqueIdentifier>
<HandleId>test</HandleId>
<HandleUniqueId>test</HandleUniqueId>
<HandleRepositoryUniqueId>test</HandleRepositoryUniqueId>
</ReferralAttachmentSummary>
<ReferralAttachmentSummary>
<Title>test</Title>
<CreationDateTime>2019-02-25T14:52:05.3407135+01:00</CreationDateTime>
<MetadataClassCode>test</MetadataClassCode>
<MetadataTypeCode>test</MetadataTypeCode>
<HealthcareFaciliyTypeCode>test</HealthcareFaciliyTypeCode>
<PracticeSettingCode>test</PracticeSettingCode>
<ReferralUniqueIdentifier>1234567891234</ReferralUniqueIdentifier>
<HandleId>test</HandleId>
<HandleUniqueId>test</HandleUniqueId>
<HandleRepositoryUniqueId>test</HandleRepositoryUniqueId>
</ReferralAttachmentSummary>
</Attachments>
</GetReferralAttachmentListResponse>
Element Descriptions:
Common:
| Element name |
Element description |
Mandatory |
| SuccessStatus |
References catalogue SuccessStatus |
YES |
| ErrorList |
List of errors |
If SuccessStatus is set to Fail |
| Attachments |
List of attachments |
If any exists |
Attachments
| Element name |
Element description |
Mandatory |
| Title |
Title of the document |
YES |
| CreationDateTime |
Date and time of attachment creation |
YES |
| MetadataClassCode |
References catalogue Class code |
YES |
| MetadataTypeCode |
References catalogue Type code (attachments) |
YES |
| HealthcareFaciliyTypeCode |
Code of the healthcare facility type |
YES |
| PracticeSettingCode |
Code of the practice setting |
YES |
| ReferralUniqueIdentifier |
Referral unique identifier |
YES |
| HandleId |
Id of the handle for the requested attachment in the storage system |
YES |
| HandleUniqueId |
Unique id of the handle for the requested attachment in the storage system |
YES |
| HandleRepositoryUniqueId |
Repository unique id of the handle for the requested attachment in the storage system |
YES |
4.11 CreateAppointments
Method which allows to create one or more appointments. The maximum number of appointments in the request is 50.
It is not possible to call it after the referral has expired. All active appointments must be in the same facility.
Onetime referral is supposed to be used only within one medical facility.
Appointment status change:
| Status before |
Status after |
| No status |
Vpisan |
Referral status change:
Onetime referral
| Status before |
|
Status after |
Izdana |
This is the first appointment |
Vpisana |
Izvedena |
It is possible to make new appointments in the period of 5 days from the first realisation |
Vpisana |
Vpisana |
Referral has one appointment in status Izveden or V izvajanju, one in status Vpisan and one more appointment is made.* |
Vpisana |
*All the appointments have to be made during the 5 days after the first realisation is registered.
Or the second appointment can be made if the first appointment is in status V izvajanju and you have 5 days to make more appointments after the second appointment has been made.
Reusable/Permanent
| Status before |
|
Status after |
Izdana |
This is the first appoinment |
Vpisana |
Vpisana |
|
Vpisana |
Izvedena |
|
Vpisana |
CreateAppointmentsRequest
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="Appointment">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="AppointmentUniqueIdentifier" type="AppointmentUnqIdenType" />
<xs:element minOccurs="1" maxOccurs="1" name="AppointmentDate" type="xs:dateTime" />
<xs:element minOccurs="1" maxOccurs="1" name="AppointmentRequestedDate" type="xs:dateTime" />
<xs:element minOccurs="0" maxOccurs="1" name="MedicalFacilityNotes" type="xs:string" />
<xs:element minOccurs="1" maxOccurs="1" name="MedicalProcedureCode" type="MedicalProcedureCodeType" />
<xs:element minOccurs="1" maxOccurs="1" name="HOSIdentifier" type="NonEmptyString" />
<xs:element minOccurs="0" maxOccurs="1" name="OfficePhone" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="OfficeNotes" type="xs:string" />
<xs:element minOccurs="1" maxOccurs="1" name="ControlExam" type="xs:boolean" />
<xs:element minOccurs="0" maxOccurs="1" name="RequestedByPatient" type="RequestedByPatientType" />
<xs:element minOccurs="0" maxOccurs="1" name="MedicallyConditioned" type="MedicallyConditionedType" />
<xs:element minOccurs="0" maxOccurs="1" name="SiteDescription" type="xs:string" />
<xs:element minOccurs="1" maxOccurs="1" name="ResponseCode" type="ResponseCodeType" />
<xs:element minOccurs="1" maxOccurs="1" name="WantsSpecificDoctor" type="xs:boolean" />
<xs:element minOccurs="1" maxOccurs="1" name="WasInformedOfOthers" type="xs:boolean" />
<xs:element minOccurs="1" maxOccurs="1" name="UrgencyType" type="UrgencyTypeForAppType" />
<xs:element minOccurs="1" maxOccurs="1" name="ReferralUniqueIdentifier" type="ReferralUidType" />
<xs:element minOccurs="1" maxOccurs="1" name="ReferralDiagnosis" type="ReferralDiagnosisType" />
<xs:element minOccurs="0" maxOccurs="1" name="PatientUniqueIdentifier" type="PatientUIdType" />
<xs:element minOccurs="1" maxOccurs="1" name="PatientInsuranceIdentifier" type="PatientInsIdType" />
<xs:element minOccurs="0" maxOccurs="1" name="PatientName" type=" xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="PatientSurname" type=" xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="PatientBirthDate" type="xs:dateTime" />
<xs:element minOccurs="0" maxOccurs="1" name="PatientGender" type="PatientGenderType" />
<xs:element minOccurs="0" maxOccurs="1" name="StreetName" type=" xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="StreetNumber" type=" xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="CityName" type=" xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="CityPostalCode" type=" xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="DistrictCode" type=" xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="PatientEMail" type="EmailType" />
<xs:element minOccurs="0" maxOccurs="1" name="PatientPhone" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="PatientMobile" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="AwareOfExpiration" type="xs:boolean" />
<xs:element minOccurs="0" maxOccurs="1" name="OfficeAddress" type="xs:string" nillable="true"/>
<xs:element minOccurs="0" maxOccurs="1" name="MedicalActivityList" type="MedicalActivityListType" nillable="true" />
<xs:element minOccurs="0" maxOccurs="1" name="SpecificDoctor" type="BPIType" />
<xs:element minOccurs="0" maxOccurs="1" name="CareTeamIdentifier" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="LocationIdentifier" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="DocIdentifier" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="DeviceIdentifier" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="AppointmentEndTime" type="xs:dateTime" nillable="true"/>
</xs:all>
</xs:complexType>
</xs:element>
<xs:element name="AppointmentsList">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="1" maxOccurs="unbounded" ref="Appointment" />
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="CreateAppointmentsRequest">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="ApiKey" type="NonEmptyString" />
<xs:element minOccurs="1" maxOccurs="1" name="HealthcareProviderIndex" type="BPIType" />
<xs:element minOccurs="0" maxOccurs="1" name="HealthcareProviderSpecificIndex" type="BPIspecificType" />
<xs:element minOccurs="1" maxOccurs="1" name="BookerIdentifier" type="BookerIdentifierType" />
<xs:element minOccurs="1" maxOccurs="1" ref="AppointmentsList" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<CreateAppointmentsRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ApiKey>ApiKey1</ApiKey>
<HealthcareProviderIndex>12681</HealthcareProviderIndex>
<HealthcareProviderSpecificIndex>12681X</HealthcareProviderSpecificIndex>
<BookerIdentifier>12365</BookerIdentifier>
<AppointmentsList>
<Appointment>
<AppointmentUniqueIdentifier>124545454500000</AppointmentUniqueIdentifier>
<AppointmentDate>1900-01-01T00:00:00</AppointmentDate>
<AppointmentRequestedDate>1990-01-01T00:00:00</AppointmentRequestedDate>
<MedicalFacilityNotes>MedicalFacilityNotes1 MedicalFacilityNotes1 MedicalFacilityNotes1</MedicalFacilityNotes>
<MedicalProcedureCode>1010P</MedicalProcedureCode>
<HOSIdentifier>HOSIdentifier1</HOSIdentifier>
<OfficePhone>OfficePhone1</OfficePhone>
<OfficeNotes>OfficeNotes1</OfficeNotes>
<ControlExam>true</ControlExam>
<RequestedByPatient>4</RequestedByPatient>
<MedicallyConditioned>3</MedicallyConditioned>
<SiteDescription>SiteDescription1</SiteDescription>
<ResponseCode>02</ResponseCode>
<WantsSpecificDoctor>false</WantsSpecificDoctor>
<WasInformedOfOthers>true</WasInformedOfOthers>
<UrgencyType>3</UrgencyType>
<ReferralUniqueIdentifier>1236541236541</ReferralUniqueIdentifier>
<ReferralDiagnosis>A08.0</ReferralDiagnosis>
<PatientUniqueIdentifier>1234567890123</PatientUniqueIdentifier>
<PatientInsuranceIdentifier>123456789</PatientInsuranceIdentifier>
<PatientName>PatientName1</PatientName>
<PatientSurname>PatientSurname1</PatientSurname>
<PatientBirthDate>1990-12-10T00:00:00</PatientBirthDate>
<PatientGender>1</PatientGender>
<StreetName>StreetName1</StreetName>
<StreetNumber>StreetNumber1</StreetNumber>
<CityName>CityName1</CityName>
<CityPostalCode>CityPostalCode1</CityPostalCode>
<DistrictCode>DistrictCode1</DistrictCode>
<PatientEMail>ime.prezime@nesto.com</PatientEMail>
<PatientPhone>065412365</PatientPhone>
<PatientMobile>031222111</PatientMobile>
</Appointment>
<Appointment>
<AppointmentUniqueIdentifier>124545454500111</AppointmentUniqueIdentifier>
<AppointmentDate>1900-01-01T00:00:00</AppointmentDate>
<AppointmentRequestedDate>1990-01-01T00:00:00</AppointmentRequestedDate>
<MedicalFacilityNotes>MedicalFacilityNotes1 MedicalFacilityNotes1 MedicalFacilityNotes1</MedicalFacilityNotes>
<MedicalProcedureCode>1010P</MedicalProcedureCode>
<HOSIdentifier>HOSIdentifier1</HOSIdentifier>
<OfficePhone>OfficePhone1</OfficePhone>
<OfficeNotes>OfficeNotes1</OfficeNotes>
<ControlExam>true</ControlExam>
<RequestedByPatient>2</RequestedByPatient>
<MedicallyConditioned>1</MedicallyConditioned>
<SiteDescription>SiteDescription1</SiteDescription>
<ResponseCode>05</ResponseCode>
<WantsSpecificDoctor>false</WantsSpecificDoctor>
<WasInformedOfOthers>false</WasInformedOfOthers>
<UrgencyType>3</UrgencyType>
<ReferralUniqueIdentifier>1236541236541</ReferralUniqueIdentifier>
<ReferralDiagnosis>A08.0</ReferralDiagnosis>
<PatientUniqueIdentifier>1234567890123</PatientUniqueIdentifier>
<PatientInsuranceIdentifier>123456789</PatientInsuranceIdentifier>
<PatientName>PatientName1</PatientName>
<PatientSurname>PatientSurname1</PatientSurname>
<PatientBirthDate>1990-12-10T00:00:00</PatientBirthDate>
<PatientGender>1</PatientGender>
<StreetName>StreetName1</StreetName>
<StreetNumber>StreetNumber1</StreetNumber>
<CityName>CityName1</CityName>
<CityPostalCode>CityPostalCode1</CityPostalCode>
<DistrictCode>DistrictCode1</DistrictCode>
<PatientEMail>ime.prezime@nesto.com</PatientEMail>
<PatientPhone>065412365</PatientPhone>
<PatientMobile>031222111</PatientMobile>
<CareTeamIdentifier>12345</CareTeamIdentifier>
<LocationIdentifier>Soba1</LocationIdentifier>
<DocIdentifier>12345</DocIdentifier>
<DeviceIdentifier>12345</DeviceIdentifier>
<AppointmentEndTime>2000-01-01T00:00:00</AppointmentEndTime>
</Appointment>
</AppointmentsList>
</CreateAppointmentsRequest>
Element Descriptions:
Appointment details:
| Element name |
Element description |
Mandatory |
| AppointmentUniqueIdentifier |
Appointment unique identifier |
YES |
| AppointmentDate |
Appointment date and time |
YES |
| AppointmentRequestedDate |
Date and time that the patient requested |
YES |
| MedicalFacilityNotes |
Notes sent by the hospital ordering system for booked appointment |
No |
| MedicalProcedureCode |
Medical procedure unique identifier (VZS) |
YES |
| HOSIdentifier |
Unique identifier of the reservation in the facility |
YES |
| OfficePhone |
Phone of the office where the medical procedure is being performed |
No |
| OfficeNotes |
Notes from the office where the medical procedure is being performed |
No |
| ControlExam |
Flag indicating if the medical procedure is control exam |
YES |
| RequestedByPatient |
References catalogue RequestedByPatientType |
No |
| MedicallyConditioned |
References catalogue MedicallyConditionedType |
No |
| SiteDescription |
Address/description of the location where medical procedure (VZS) is performed (e.g. “Bolnišnica dr. Petra Držaja, Vodnikova 62, 1000 Ljubljana”) |
No |
| ResponseCode |
References catalogue ResponseCodeType |
YES |
| WantsSpecificDoctor |
True or False. Indicates if the appointment was selected based on the doctor performing the medical procedure |
YES |
| WasInformedOfOthers |
True or False. Indicates if the patient was aware of other earlier appointments (if existed) when reservation was made. Used when selected appointment is outside legal boundaries for medical procedure |
YES |
| UrgencyTypeCode |
Urgency type code (References catalogue UrgencyCodeType) |
YES |
| ReferralUniqueIdentifier |
Referral unique identifier |
YES |
| ReferralDiagnosis |
Diagnosis on the referral |
YES |
| PatientUniqueIdentifier |
Unique identifier of the patient (EMŠO) |
No |
| PatientInsuranceIdentifier |
Insurance identifier of the patient (KZZ) |
YES |
| PatientName |
Patient first name |
No |
| PatientSurname |
Patient last name |
No |
| PatientBirthDate |
Patient birth date |
No |
| PatientGender |
Patient gender (References catalogue PatientGenderType) |
No |
| StreetName |
Street where the patient lives |
NO if DistrictCode is 000 |
| StreetNumber |
Street number where the patient lives |
NO if DistrictCode is 000 |
| CityName |
Name of the city patient lives in |
NO if DistrictCode is 000 |
| CityPostalCode |
Postal code of the city patient lives in |
NO if DistrictCode is 000 |
| DistrictCode |
Code of the district patient lives in |
No |
| PatientEMail |
Patient email |
No |
| PatientPhone |
Patient phone |
No |
| PatientMobile |
Patient mobile |
No |
| AwareOfExpiration |
True or False. Indicates if user is aware they are trying to create appointment after the allowed period based on urgency codes |
No |
| OfficeAddress |
Address of location where procedure can be made |
No |
| MedicalActivityList |
Code list of Doctors medical activities |
No |
| SpecificDoctor |
RIZDDZ of a specific doctor (Mandatory if WantsSpecificDoctor is true) |
No |
| CareTeamIdentifier |
Care team identifier |
No |
| LocationIdentifier |
Ambulance/room where the medical procedure is being performed |
Only if medical facility uses process D |
| DocIdentifier |
Doctor identifier |
No |
| DeviceIdentifier |
Device identifier |
No |
| AppointmentEndTime |
Information about end time of appointment |
Only if medical facility uses process D |
Common:
| Element name |
Element description |
Mandatory |
| ApiKey |
Application key of the application making the request |
YES |
| HealthcareProviderIndex |
Medical facility code (BPI) |
YES |
| HealthcareProviderSpecificIndex |
Medical facility specific code (Used when multiple software vendors maintain the IS of the same facility) |
Only if exists |
| BookerIdentifier |
Unique identifier (BPI) of the person which made the reservation |
YES |
| AppointmentsList |
List of appointments |
YES |
CreateAppointmentsResponse
XSD Schema:
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="CreateAppointmentsResponse">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="SuccessStatus" type="SuccessStatusType" />
<xs:element minOccurs="0" maxOccurs="1" name="ErrorList" type="ErrorListType" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<CreateAppointmentsResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SuccessStatus>1</SuccessStatus>
</CreateAppointmentsResponse>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| SuccessStatus |
References catalogue SuccessStatus |
YES |
| ErrorList |
List of errors |
If SuccessStatus is set to Fail |
4.12 UpdateAppointments
Mehod which allows to update one or more appointments.
Appointment can only be updated by the medical facility where the appointment is scheduled.
Appointment can be transferred to a new referral only if the old referral expires within 15 days.
The maximum number of appointments in the request is 50.
UpdateAppointmentsRequest
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="AppointmentUpdate">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="AppointmentUniqueIdentifier" type="AppointmentUnqIdenType" />
<xs:element minOccurs="0" maxOccurs="1" name="NewReferralUniqueIdentifier" type="ReferralUidType" />
<xs:element minOccurs="0" maxOccurs="1" name="PatientEMail" type="EmailType" />
<xs:element minOccurs="0" maxOccurs="1" name="PatientMobile" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="NewAppointmentDate" type="xs:dateTime" />
<xs:element minOccurs="0" maxOccurs="1" name="RequestedByPatientCode" type="xs:string" nillable ="true" />
<xs:element minOccurs="0" maxOccurs="1" name="MedicallyConditionedCode" type="xs:string" nillable ="true" />
<xs:element minOccurs="0" maxOccurs="1" name="SiteDescription" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="OfficeNotes" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="MedicalFacilityNotes" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="ResponseCode" type="ResponseCodeType" />
<xs:element minOccurs="0" maxOccurs="1" name="ControlExam" type="xs:boolean" />
<xs:element minOccurs="0" maxOccurs="1" name="WantsSpecificDoctor" type="xs:boolean" />
<xs:element minOccurs="0" maxOccurs="1" name="WasInformedOfOthers" type="xs:boolean" />
<xs:element minOccurs="0" maxOccurs="1" name="MedicalProcedureCode" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="ReorderingReasonCode" type="ReorderingReasonTypeCode" />
<xs:element minOccurs="0" maxOccurs="1" name="ReorderingCoefficient" type="xs:double" />
<xs:element minOccurs="0" maxOccurs="1" name="UrgencyType" type="UrgencyTypeForAppType" />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“ReasonForChangingUrgencyType“ type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="SpecificDoctor" type="BPIType" />
<xs:element minOccurs="0" maxOccurs="1" name="CareTeamIdentifier" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="LocationIdentifier" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="DocIdentifier" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="DeviceIdentifier" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="AppointmentEndTime" type="xs:dateTime" nillable="true"/>
</xs:all>
</xs:complexType>
</xs:element>
<xs:element name="UpdatedAppointmentsList">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="1" maxOccurs="unbounded" ref="AppointmentUpdate" />
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="UpdateAppointmentsRequest">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="ApiKey" type="NonEmptyString" />
<xs:element minOccurs="1" maxOccurs="1" name="HealthcareProviderIndex" type="BPIType" />
<xs:element minOccurs="0" maxOccurs="1" name="HealthcareProviderSpecificIndex" type="BPIspecificType" />
<xs:element minOccurs="1" maxOccurs="1" ref="UpdatedAppointmentsList" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<UpdateAppointmentsRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ApiKey>test</ApiKey>
<HealthcareProviderIndex>10000</HealthcareProviderIndex>
<HealthcareProviderSpecificIndex>10000A</HealthcareProviderSpecificIndex>
<UpdatedAppointmentsList>
<AppointmentUpdate>
<AppointmentUniqueIdentifier>121212545400036</AppointmentUniqueIdentifier>
<NewReferralUniqueIdentifier>1213651236540</NewReferralUniqueIdentifier>
<PatientEMail>ime.prezime@nesto.com</PatientEMail>
<PatientMobile>021458741</PatientMobile>
<RequestedByPatientCode>2</RequestedByPatientCode>
<MedicallyConditionedCode>1</MedicallyConditionedCode>
<SiteDescription/>
<OfficeNotes/>
<ResponseCode>05</ResponseCode>
<ControlExam>true</ControlExam>
<WantsSpecificDoctor>true</WantsSpecificDoctor>
<WasInformedOfOthers>false</WasInformedOfOthers>
<ReorderingReasonCode>1</ReorderingReasonCode>
<ReorderingCoefficient>1.2</ReorderingCoefficient>
</AppointmentUpdate>
<AppointmentUpdate>
<AppointmentUniqueIdentifier>121212545411125</AppointmentUniqueIdentifier>
<NewReferralUniqueIdentifier>1213651236540</NewReferralUniqueIdentifier>
<PatientEMail>ime.prezime@nesto.com</PatientEMail>
<PatientMobile>021458741</PatientMobile>
<ResponseCode>02</ResponseCode>
<ControlExam>false</ControlExam>
<WantsSpecificDoctor>false</WantsSpecificDoctor>
<WasInformedOfOthers>false</WasInformedOfOthers>
<MedicalProcedureCode>1053P </MedicalProcedureCode>
<CareTeamIdentifier>12345</CareTeamIdentifier>
<LocationIdentifier>Soba1</LocationIdentifier>
<DocIdentifier>12345</DocIdentifier>
<DeviceIdentifier>12345</DeviceIdentifier>
<AppointmentEndTime>2000-01-01T00:00:00</AppointmentEndTime>
</AppointmentUpdate>
</UpdatedAppointmentsList>
</UpdateAppointmentsRequest>
Element Descriptions:
Common:
| Element name |
Element description |
Mandatory |
| ApiKey |
Application key of the application making the request |
YES |
| HealthcareProviderIndex |
Medical facility code (BPI) |
YES |
| HealthcareProviderSpecificIndex |
Medical facility specific code (Used when multiple software vendors maintain the IS of the same facility) |
Only if exists |
| UpdatedAppointmentsList |
List of appointments |
YES |
Appointment details:
| Element name |
Element description |
Mandatory |
| AppointmentUniqueIdentifier |
Appointment unique identifier |
YES |
| NewReferralUniqueIdentifier |
New referral unique identifier |
Only if appointments have to be linked to new referral |
| PatientEMail |
New email of the patient |
Only if email changes |
| PatientMobile |
New mobile number of the patient |
Only if mobile number changes |
| NewAppointmentDate |
New appointment date and time |
Only if appointment date and time changes |
| RequestedByPatientCode |
References catalogue RequestedByPatientType |
If changed |
| MedicallyConditionedCode |
References catalogue MedicallyConditionedType |
If changed |
| SiteDescription |
Address/description of the location where medical procedure (VZS) is performed (i.e. “Bolnišnica dr. Petra Držaja, Vodnikova 62, 1000 Ljubljana”) |
If changed |
| OfficeNotes |
Notes from the office where the medical procedure is being performed (i.e. “Additional explanations can be obtained by post”) |
If changed |
| MedicalFacilityNotes |
Notes about the appointment |
If changed |
| ResponseCode |
References catalogue ResponseCodeType |
If changed |
| ControlExam |
Flag indicating if the medical procedure is control exam |
If changed |
| WantsSpecificDoctor |
True or False. Indicates if the appointment was selected based on the doctor performing the medical procedure |
If changed |
| WasInformedOfOthers |
True or False. Indicates if the patient was aware of other earlier appointments (if they existed at the time when the reservation was made). Used when the selected appointment is outside of the legal boundaries for medical procedure |
If changed |
| MedicalProcedureCode |
Medical procedure unique identifier (VZS) |
If changed |
| ReorderingReasonCode |
References catalogue ReorderingReasonCode |
Only if appointment has been reordered |
| ReorderingCoefficient |
Coefficient used to prioritize patients for reordering |
Only if appointment has been reordered |
| UrgencyType |
Urgency type code (References catalogue UrgencyCodeType) |
If changed |
| SpecificDoctor |
RIZDDZ number of specific doctor |
NO, but it is mandatory if element WantsSpecificDoctor is true |
| ReasonForChangingUrgencyType |
Description of reason what is the cause for changing urgency type |
NO, but it is mandatory when user is changing urgency type |
| CareTeamIdentifier |
Care team identifier |
If changed |
| LocationIdentifier |
Ambulance/room where the medical procedure is being performed |
Only if medical facility uses process D |
| DocIdentifier |
Doctor identifier |
No |
| DeviceIdentifier |
Device identifier |
No |
| AppointmentEndTime |
Information about end time of appointment |
Only if medical facility uses process D |
UpdateAppointmentsResponse
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="UpdateAppointmentsResponse">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="SuccessStatus" type="SuccessStatusType" />
<xs:element minOccurs="0" maxOccurs="1" name="ErrorList" type="ErrorListType" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
Successful response:
<?xml version="1.0" encoding="utf-8"?>
<UpdateAppointmentsResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SuccessStatus>1</SuccessStatus>
</UpdateAppointmentsResponse>
Partial success:
Only unsuccessfull update was not registered
<UpdateAppointmentsResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SuccessStatus>3</SuccessStatus>
<ErrorList>
<Error>
<Code>7</Code>
<Description>Neveljaven edinstveni identifikator naročila!</Description>
<AppointmentUniqueIdentifier>123456589123450</AppointmentUniqueIdentifier>
</Error>
</ErrorList>
</UpdateAppointmentsResponse>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| SuccessStatus |
References catalogue SuccessStatus |
YES |
| ErrorList |
List of errors |
If SuccessStatus is set to Fail or Partial |
4.13 CreateAdmission
Method used to register a patient admission. It is not possible to call it after the referral has been expired.
Admission can only be made by the medical facility where appointment is scheduled.
Admission can only be called for appointments that have active VZS.
Appointment status change:
| Status before |
Status after |
Vpisan |
V izvajanju |
Referral status change:
Onetime/Reusable/Permanent referral
| Status before |
|
Status after |
Vpisana |
In case of admission the referral status remains the same |
Vpisana |
CreateAdmissionRequest
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="CreateAdmissionRequest">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="ApiKey" type="NonEmptyString" />
<xs:element minOccurs="1" maxOccurs="1" name="HealthcareProviderIndex" type="BPIType" />
<xs:element minOccurs="0" maxOccurs="1" name="HealthcareProviderSpecificIndex" type="BPIspecificType" />
<xs:element minOccurs="1" maxOccurs="1" name="ReferralUniqueIdentifier" type="ReferralUidType" />
<xs:element minOccurs="1" maxOccurs="1" name="AppointmentUniqueIdentifier" type="AppointmentUnqIdenType" />
<xs:element minOccurs="1" maxOccurs="1" name="AdmissionOrgIdentifier" type="NonEmptyString" />
<xs:element minOccurs="1" maxOccurs="1" name="AdmissionOrgName" type="NonEmptyString" />
<xs:element minOccurs="1" maxOccurs="1" name="AdmissionOrgDepartmentIden1" type="MedicalActivityFirstSecondTypeCode" />
<xs:element minOccurs="1" maxOccurs="1" name="AdmissionOrgDepartmentIden2" type="MedicalActivityFirstSecondTypeCode" />
<xs:element minOccurs="1" maxOccurs="1" name="AdmissionDocIdentifier" type="NonEmptyString" />
<xs:element minOccurs="1" maxOccurs="1" name="AdmissionDocGivenName" type="NonEmptyString" />
<xs:element minOccurs="1" maxOccurs="1" name="AdmissionDocFamilyName" type="NonEmptyString" />
<xs:element minOccurs="1" maxOccurs="1" name="AdmissionOrgInPublicHealth" type="xs:boolean" />
<xs:element minOccurs="1" maxOccurs="1" name="AdmissionDatetime" type="xs:dateTime" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<CreateAdmissionRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ApiKey>test</ApiKey>
<HealthcareProviderIndex>10000</HealthcareProviderIndex>
<ReferralUniqueIdentifier>1234567891234</ReferralUniqueIdentifier>
<AppointmentUniqueIdentifier>123456789123456</AppointmentUniqueIdentifier>
<AdmissionOrgIdentifier>orgIdent</AdmissionOrgIdentifier>
<AdmissionOrgName>orgName</AdmissionOrgName>
<AdmissionOrgDepartmentIden1>123</AdmissionOrgDepartmentIden1>
<AdmissionOrgDepartmentIden2>456</AdmissionOrgDepartmentIden2>
<AdmissionDocIdentifier>testDoc</AdmissionDocIdentifier>
<AdmissionDocGivenName>testName</AdmissionDocGivenName>
<AdmissionDocFamilyName>testName</AdmissionDocFamilyName>
<AdmissionOrgInPublicHealth>false</AdmissionOrgInPublicHealth>
<AdmissionDatetime>2019-01-01T00:00:00</AdmissionDatetime>
</CreateAdmissionRequest>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| ApiKey |
Application key of the application making the request |
YES |
| HealthcareProviderIndex |
Medical facility code (BPI) |
YES |
| HealthcareProviderSpecificIndex |
Medical facility specific code (Used when multiple software vendors maintain the IS of the same facility) |
Only if exists |
| ReferralUniqueIdentifier |
Referral unique identifier |
YES |
| AppointmentUniqueIdentifier |
Appointment unique identifier |
YES |
| AdmissionOrgIdentifier |
Identifier of the facility patient was admitted to |
YES |
| AdmissionOrgName |
Name of the facility patient was admitted to |
YES |
| AdmissionOrgDepartmentIden1 |
First level identifier of the department patient was admitted to |
YES |
| AdmissionOrgDepartmentIden2 |
Second level identifier of the department patient was admitted to |
YES |
| AdmissionDocIdentifier |
Identifier of the doctor that admitted the patient |
YES |
| AdmissionDocGivenName |
First name of the doctor that admitted the patient |
YES |
| AdmissionDocFamilyName |
Last name of the doctor that admitted the patient |
YES |
| AdmissionOrgInPublicHealth |
Flag indicating if the facility patient was admitted to is in public health system |
YES |
| AdmissionDatetime |
Date and time patient was admitted at |
YES |
CreateAdmissionResponse
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="CreateAdmissionResponse">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="SuccessStatus" type="SuccessStatusType" />
<xs:element minOccurs="0" maxOccurs="1" name="ErrorList" type="ErrorListType" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<CreateAdmissionResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SuccessStatus>2</SuccessStatus>
<ErrorList>
<Error>
<Code>0002</Code>
<Description>test1</Description>
</Error>
<Error>
<Code>2</Code>
<Description>test2</Description>
</Error>
</ErrorList>
</CreateAdmissionResponse>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| SuccessStatus |
References catalogue SuccessStatus |
YES |
| ErrorList |
List of errors |
If SuccessStatus is set to Fail |
4.14 AppointmentRealisation
Method which is used to conclude patient’s examination. The rules for calling this method are:
- It can be called after the referral expired
- RealisationDateTime value has to be before the referral expiration date
i.e. if the referral was valid till 15.06.2019. the value of RealisationDateTime has to be less or equal to this date.
- RealisationDateTime value is not able to be before the ReferralCreationDatetime.
- It can be called only for appointments that have active VZS.
Appointment status change:
| Status before |
Status after |
V izvajanju |
Izveden |
Referral status change:
Onetime referral:
| Status before |
Condition |
Status after |
Vpisana |
No more appointments (all are in Done status or Cancel status) and referral has at least one realisation |
Izkoriščena |
Vpisana |
There are appointments in status Vpisan or V izvajanju |
Vpisana |
Vpisana |
There are appointments in status Vpisan or V izvajanju but the flag ControlNotNeeded was set to true. In this case we will cancel all the remaining active appointments |
Izkoriščena |
Vpisana |
This is first realisation on referral and referral has no other active appointments |
Izvedena |
Reusable/Permanent referral:
| Status before |
Condition |
Status after |
Vpisana |
No more appointments (or all are in Done status) |
Izvedena |
Vpisana |
There are appointments in status Vpisan or V izvajanju |
Vpisana |
Vpisana |
There are appointments in status Vpisan or V izvajanju but the flag ControlNotNeeded was set to true. In this case we will cancel all the remaining appointments |
Izkoriščena |
Vpisana |
There are no more appointments and the flag ControlNotNeeded was set to true |
Izkoriščena |
AppointmentRealisationRequest
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="AppointmentRealisationRequest">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="ApiKey" type="NonEmptyString" />
<xs:element minOccurs="1" maxOccurs="1" name="HealthcareProviderIndex" type="BPIType" />
<xs:element minOccurs="0" maxOccurs="1" name="HealthcareProviderSpecificIndex" type="BPIspecificType" />
<xs:element minOccurs="1" maxOccurs="1" name="AppointmentUniqueIdentifier" type="AppointmentUnqIdenType" />
<xs:element minOccurs="1" maxOccurs="1" name="ReferralUniqueIdentifier" type="ReferralUidType" />
<xs:element minOccurs="1" maxOccurs="1" name="RealisationDocIdentifier" type="NonEmptyString" />
<xs:element minOccurs="1" maxOccurs="1" name="RealisationDateTime" type="xs:dateTime" />
<xs:element minOccurs="1" maxOccurs="1" name="MedicalProcedureCode" type="MedicalProcedureCodeType" />
<xs:element minOccurs="0" maxOccurs="1" name="EarliestControlDate" type="xs:dateTime" />
<xs:element minOccurs="1" maxOccurs="1" name="ControlNotNeeded" type="xs:boolean" />
<xs:element minOccurs="1" maxOccurs="1" name="StartTreatment" type="xs:boolean" />
<xs:element minOccurs="0" maxOccurs="1" name="LocationIdentifier" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="CareTeamIdentifier" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="DeviceIdentifier" type="xs:string" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<AppointmentRealisationRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ApiKey>test</ApiKey>
<HealthcareProviderIndex>12681</HealthcareProviderIndex>
<HealthcareProviderSpecificIndex>12681P</HealthcareProviderSpecificIndex>
<AppointmentUniqueIdentifier>126816789123456</AppointmentUniqueIdentifier>
<ReferralUniqueIdentifier>2017062900001</ReferralUniqueIdentifier>
<RealisationDocIdentifier>RealisationDocIdentifier</RealisationDocIdentifier>
<RealisationDateTime>2020-01-04T00:00:00</RealisationDateTime>
<MedicalProcedureCode>1053P</MedicalProcedureCode>
<EarliestControlDate>2020-01-01T00:00:00</EarliestControlDate>
<ControlNotNeeded>false</ControlNotNeeded>
<StartTreatment>false</StartTreatment>
<LocationIdentifier>01234</LocationIdentifier>
<CareTeamIdentifier>01234</CareTeamIdentifier>
<DeviceIdentifier>01234</DeviceIdentifier>
</AppointmentRealisationRequest>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| ApiKey |
Application key of the application making the request |
YES |
| HealthcareProviderIndex |
Medical facility code (BPI) |
YES |
| HealthcareProviderSpecificIndex |
Medical facility specific code (Used when multiple software vendors maintain the IS of the same facility) |
Only if exists |
| AppointmentUniqueIdentifier |
Appointment unique identifier |
YES |
| ReferralUniqueIdentifier |
Referral unique identifier |
YES |
| RealisationDocIdentifier |
Identifier of the doctor who performed the medical procedure |
YES |
| RealisationDateTime |
Realisation date and time |
YES |
| MedicalProcedureCode |
Unique identifier of the medical procedure (VZS) |
YES |
| EarliestControlDate |
Earliest date of the next control exam for referral |
NO |
| ControlNotNeeded |
Flag to indicate that patient does not need any further control exams |
YES |
| StartTreatment |
Flag to indicate that patient has to start with the treatment and take no further control exams |
YES |
| LocationIdentifier |
Ambulance/room where the medical procedure is being performed |
Only if medical facility uses process D |
| CareTeamIdentifier |
Care team identifier |
NO |
| DeviceIdentifier |
Device identifier |
NO |
AppointmentRealisationResponse
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="AppointmentRealisationResponse">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="SuccessStatus" type="SuccessStatusType" />
<xs:element minOccurs="0" maxOccurs="1" name="ErrorList" type="ErrorListType" />
<xs:element minOccurs="0" maxOccurs="1" name="InfoList" type="InfoListType" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<AppointmentRealisationResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SuccessStatus>2</SuccessStatus>
<ErrorList>
<Error>
<Code>0002</Code>
<Description>Napaka</Description>
</Error>
</ErrorList>
</AppointmentRealisationResponse>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| SuccessStatus |
References catalogue SuccessStatus |
YES |
| ErrorList |
List of errors |
If SuccessStatus is set to Fail |
4.15 CancelAppointmentRealisation
Method which is used to cancel the realisation of the appointment. The rules for calling this method are:
- It is not allowed to call this method after referral has expired
- It can be called till the end of the month in which the realisation was registered + 5 days (the referral must be valid)
Examples:
- Referral is valid till 15.6.2019. The realization was registered 10.5.2019. It is possible to call this method till 5.6.2019.
- Referral is valid till 15.6.2019. The realization was registered 10.6.2019. It is possible to call this method only till 15.6.2019.
Appointment status change:
| Status before |
Status after |
Izveden |
V izvajanju |
Referral status change:
Onetime/Reusable/Permanent referral:
| Status before |
Condition |
Status after |
Izvedena |
|
Vpisana |
Vpisana |
|
Vpisana |
Izkoriščena |
If last realization is called with flag ControlNotNeeded, only then status of referral goes from Izkoriščena to Vpisana. |
Vpisana |
CancelAppointmetRealisationRequest
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="CancelAppointmentRealisationRequest">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="ApiKey" type="NonEmptyString" />
<xs:element minOccurs="1" maxOccurs="1" name="HealthcareProviderIndex" type="BPIType" />
<xs:element minOccurs="0" maxOccurs="1" name="HealthcareProviderSpecificIndex" type="BPIspecificType" />
<xs:element minOccurs="1" maxOccurs="1" name="AppointmentUniqueIdentifier" type="AppointmentUnqIdenType" />
<xs:element minOccurs="1" maxOccurs="1" name="ReferralUniqueIdentifier" type="ReferralUidType" />
<xs:element minOccurs="1" maxOccurs="1" name="CancelledBy" type="NonEmptyString" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<CancelAppointmentRealisationRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ApiKey>test</ApiKey>
<HealthcareProviderIndex>10000</HealthcareProviderIndex>
<AppointmentUniqueIdentifier>123456789123456</AppointmentUniqueIdentifier>
<ReferralUniqueIdentifier>1234567891234</ReferralUniqueIdentifier>
<CancelledBy>12345</CancelledBy>
</CancelAppointmentRealisationRequest>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| ApiKey |
Application key of the application making the request |
YES |
| HealthcareProviderIndex |
Medical facility code (BPI) |
YES |
| HealthcareProviderSpecificIndex |
Medical facility specific code (Used when multiple software vendors maintain the IS of the same facility) |
Only if exists |
| AppointmentUniqueIdentifier |
Appointment unique identifier |
YES |
| ReferralUniqueIdentifier |
Referral unique identifier |
YES |
| CancelledBy |
Unique identifier (BPI) of the person which cancelled the realisation |
YES |
CancelAppointmentRealisationResponse
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="CancelAppointmentRealisationResponse">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="SuccessStatus" type="SuccessStatusType" />
<xs:element minOccurs="0" maxOccurs="1" name="ErrorList" type="ErrorListType" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<CancelAppointmentRealisationResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SuccessStatus>2</SuccessStatus>
<ErrorList>
<Error>
<Code>0002</Code>
<Description>test1</Description>
</Error>
<Error>
<Code>2</Code>
<Description>test2</Description>
</Error>
</ErrorList>
</CancelAppointmentRealisationResponse>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| SuccessStatus |
References catalogue SuccessStatus |
YES |
| ErrorList |
List of errors |
If SuccessStatus is set to Fail |
4.16 CancelAdmission
Method which is used to cancel a patient admission. It is not possible to call it after the referral has been expired.
Appointment status change:
| Status before |
Status after |
V izvajanju |
Vpisan |
Referral status change:
Onetime/Reusable/Permanent referral:
| Status before |
Condition |
Status after |
Vpisana |
Admission does not change the referral status, so if this method is called the status remains the same. |
Vpisana |
CancelAdmissionRequest
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="CancelAdmissionRequest">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="ApiKey" type="NonEmptyString" />
<xs:element minOccurs="1" maxOccurs="1" name="HealthcareProviderIndex" type="BPIType" />
<xs:element minOccurs="1" maxOccurs="1" name="ReferralUniqueIdentifier" type="ReferralUidType" />
<xs:element minOccurs="1" maxOccurs="1" name="AppointmentUniqueIdentifier" type="AppointmentUnqIdenType" />
<xs:element minOccurs="1" maxOccurs="1" name="CancelledBy" type="NonEmptyString" />
<xs:element minOccurs="0" maxOccurs="1" name="HealthcareProviderSpecificIndex" type="BPIspecificType" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<CancelAdmissionRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ApiKey>test</ApiKey>
<HealthcareProviderIndex>50001</HealthcareProviderIndex>
<ReferralUniqueIdentifier>2020062900001</ReferralUniqueIdentifier>
<AppointmentUniqueIdentifier>500014512121241</AppointmentUniqueIdentifier>
<CancelledBy>12345</CancelledBy>
</CancelAdmissionRequest>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| ApiKey |
Application key of the application making the request |
YES |
| HealthcareProviderIndex |
Medical facility code (BPI) |
YES |
| ReferralUniqueIdentifier |
Referral unique identifier |
YES |
| AppointmentUniqueIdentifier |
Appointment unique identifier |
YES |
| CancelledBy |
Unique identifier (BPI) of the person which cancelled the admission |
YES |
| HealthcareProviderSpecificIndex |
Medical facility specific code (Used when multiple software vendors maintain the IS of the same facility) |
Only if exists |
CancelAdmissionResponse
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="CancelAdmissionResponse">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="SuccessStatus" type="SuccessStatusType" />
<xs:element minOccurs="0" maxOccurs="1" name="ErrorList" type="ErrorListType" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<CancelAdmissionResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SuccessStatus>2</SuccessStatus>
<ErrorList>
<Error>
<Code>0002</Code>
<Description>test1</Description>
</Error>
<Error>
<Code>2</Code>
<Description>test2</Description>
</Error>
</ErrorList>
</CancelAdmissionResponse>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| SuccessStatus |
References catalogue SuccessStatus |
YES |
| ErrorList |
List of errors |
If SuccessStatus is set to Fail |
4.17 CancelAppointments
Method which allows to cancel one or more appointments. The maximum number of appointments in the request is 50.
Only medical facility in which appointments are scheduled are allowed to cancel those appointments.
Appointment status change:
| Status before |
Status after |
Vpisan |
Preklican |
Referral status change:
Onetime referral:
| Status before |
Condition |
Status after |
Vpisana |
This is the only appointment |
Izdana |
Vpisana |
There are more appointments in status Vpisan/ V izvajanju |
Vpisana |
Vpisana |
All the other appointments are completed and referral has at least one realization |
Izkoriščena |
Vpisana |
The cancellation reason is unjustified and date of appointment has passed (if there are other open appointments they will be cancelled) |
Izkoriščena / Ni izkoriščena depending if any appointment was completed |
Izkoriščena / Ni izkoriščena |
There are one or more active appointments (exact or tentative terms) without admissions |
Izkoriščena / Ni izkoriščena |
Reusable/Permanent referral:
| Status before |
Condition |
Status after |
Vpisana |
This is the only appointment |
Izdana |
Vpisana |
There are more appointments in status Vpisan/ V izvajanju |
Vpisana |
Vpisana |
There are more appointments that are completed |
Izvedena |
Vpisana |
The cancellation reason is unjustified (if there are other open appointments they will be cancelled) |
Izkoriščena / Ni izkoriščena depending if any appointment was completed |
Izkoriščena / Ni izkoriščena |
There are one or more active appointments (exact or tentative terms) without admissions |
Izkoriščena / Ni izkoriščena |
CancelAppointmentsRequest
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:include schemaLocation="AppointmentCancellationReasonsList.xsd" />
<xs:element name="CancelAppoitmentDetails">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="AppointmentUniqueIdentifier" type="AppointmentUnqIdenType" />
<xs:element minOccurs="1" maxOccurs="1" name="ReferralUniqueIdentifier" type="ReferralUidType" />
<xs:element minOccurs="1" maxOccurs="1" name="CancelledBy" type="NonEmptyString" />
<xs:element minOccurs="1" maxOccurs="1" name="CancellationReasonCode" type="AppointmentCancellationReasonType" />
<xs:element minOccurs="0" maxOccurs="1" name="CancellationReasonDescription" type="xs:string" />
</xs:all>
</xs:complexType>
</xs:element>
<xs:element name="CancelAppoitmentDetailsList">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="1" maxOccurs="unbounded" ref="CancelAppoitmentDetails" />
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="CancelAppointmentsRequest">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="ApiKey" type="NonEmptyString" />
<xs:element minOccurs="1" maxOccurs="1" name="HealthcareProviderIndex" type="BPIType" />
<xs:element minOccurs="0" maxOccurs="1" name="HealthcareProviderSpecificIndex" type="BPIspecificType" />
<xs:element minOccurs="1" maxOccurs="1" ref="CancelAppoitmentDetailsList" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<CancelAppointmentsRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ApiKey>test</ApiKey>
<HealthcareProviderIndex>10000</HealthcareProviderIndex>
<HealthcareProviderSpecificIndex>10000A</HealthcareProviderSpecificIndex>
<CancelAppoitmentDetailsList>
<CancelAppoitmentDetails>
<AppointmentUniqueIdentifier>123456789123456</AppointmentUniqueIdentifier>
<ReferralUniqueIdentifier>1234567891234</ReferralUniqueIdentifier>
<CancelledBy>12345</CancelledBy>
<CancellationReasonCode>5</CancellationReasonCode>
<CancellationReasonDescription>description</CancellationReasonDescription>
</CancelAppoitmentDetails>
</CancelAppoitmentDetailsList>
</CancelAppointmentsRequest>
Element Descriptions:
Common:
| Element name |
Element description |
Mandatory |
| ApiKey |
Application key of the application making the request |
YES |
| HealthcareProviderIndex |
Medical facility code (BPI) |
YES |
| HealthcareProviderSpecificIndex |
Medical facility specific code (Used when multiple software vendors maintain the IS of the same facility) |
Only if exists |
| CancelAppoitmentDetailsList |
List of appointments to cancel |
YES |
Appointment details:
| Element name |
Element description |
Mandatory |
| AppointmentUniqueIdentifier |
Appointment unique identifier |
YES |
| ReferralUniqueIdentifier |
Referral unique identifier |
YES |
| CancelledBy |
Unique identifier (BPI) of the person which cancelled the appointment |
YES |
| CancellationReasonCode |
Cancellation reason code (References catalogue AppointmentCancellationReasonType) |
YES |
| CancellationReasonDescription |
Additional notes about the cancellation |
Only if cancellation reason is Ostalo |
CancelAppointmentsResponse
XSD Schema:
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="CancelAppointmentsResponse">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="SuccessStatus" type="SuccessStatusType" />
<xs:element minOccurs="0" maxOccurs="1" name="ErrorList" type="ErrorListType" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<CancelAppointmentsResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SuccessStatus>2</SuccessStatus>
<ErrorList>
<Error>
<Code>0002</Code>
<Description>test1</Description>
</Error>
<Error>
<Code>2</Code>
<Description>test2</Description>
</Error>
</ErrorList>
</CancelAppointmentsResponse>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| SuccessStatus |
References catalogue SuccessStatus |
YES |
| ErrorList |
List of errors |
If SuccessStatus is set to Fail |
4.18 GetAppointment
Method which allows to get the details about a single appointment.
GetAppointmentRequest
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="GetAppointmentRequest">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="ApiKey" type="NonEmptyString" />
<xs:element minOccurs="1" maxOccurs="1" name="AppointmentUniqueIdentifier" type="AppointmentUnqIdenType" />
<xs:element minOccurs="0" maxOccurs="1" name="PatientInsuranceIdentifier" type="PatientInsIdType" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<GetAppointmentRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ApiKey>test</ApiKey>
<AppointmentUniqueIdentifier>123456789123456</AppointmentUniqueIdentifier>
<PatientInsuranceIdentifier>123456789</PatientInsuranceIdentifier>
</GetAppointmentRequest>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| ApiKey |
Application key of the application making the request |
YES |
| AppointmentUniqueIdentifier |
Appointment unique identifier |
YES |
| PatientInsuranceIdentifier |
Patient insurance identifier (KZZ) |
NO |
GetAppointmentResponse
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="AppointmentSummary.xsd" />
<xs:element name="Appointment" type="AppointmentSummary" />
<xs:element name="GetAppointmentResponse">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="SuccessStatus" type="SuccessStatusType" />
<xs:element minOccurs="0" maxOccurs="1" name="ErrorList" type="ErrorListType"/>
<xs:element minOccurs="0" maxOccurs="1" ref="Appointment" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<GetAppointmentResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SuccessStatus>1</SuccessStatus>
<Appointment>
<AppointmentUniqueIdentifier>857832202022168</AppointmentUniqueIdentifier>
<MedicalFacilityName>Testna Ustanova</MedicalFacilityName>
<MedicalFacilityAddress>Štefanova 5</MedicalFacilityAddress>
<MedicalFacilityPhone>01-478 6098</MedicalFacilityPhone>
<MedicalFacilityFax>01-478 6099</MedicalFacilityFax>
<MedicalFacilityEMail>test@test.si</MedicalFacilityEMail>
<PatientNameAndSurname>Ivica Kostelic</PatientNameAndSurname>
<StreetName>Ljubljanska cesta</StreetName>
<StreetNumber>2</StreetNumber>
<CityName>Novo mesto</CityName>
<CityPostalCode>8000</CityPostalCode>
<DistrictCode>085</DistrictCode>
<PatientUniqueIdentifier>1234567890123</PatientUniqueIdentifier>
<PatientInsuranceIdentifier>123456789</PatientInsuranceIdentifier>
<PatientPhone>015555879</PatientPhone>
<PatientMobile>031555879</PatientMobile>
<PatientEmail>ivica.kostelic@mail.com</PatientEmail>
<MedicalProcedureName>Kardiovaskularni kirurski pregled -– prvi</MedicalProcedureName>
<SiteDescription>Hospital 54321</SiteDescription>
<MedicalFacilityNotes>No data</MedicalFacilityNotes>
<ResponseCode>01</ResponseCode>
<HOSIdentifier>4952</HOSIdentifier>
<HealthcareProviderIndex>12345</HealthcareProviderIndex>
<HealthcareProviderSpecificIndex>10000A</HealthcareProviderSpecificIndex>
<ReferralUniqueIdentifier>2014012500041</ReferralUniqueIdentifier>
<OldReferralUniqueIdentifier>2014012500040</OldReferralUniqueIdentifier>
<AppointmentStatus>CONF</AppointmentStatus>
<CancellationDateTime>2019-03-01T00:00:00</CancellationDateTime>
<RealisationDateTime>2019-03-01T00:00:00</RealisationDateTime>
<UrgencyType>3</UrgencyType>
<DocumentTypeCode>0</DocumentTypeCode>
<CareTeamIdentifier>testni_tim1</CareTeamIdentifier>
<LocationIdentifier>testna_lokacija1</LocationIdentifier>
<DeviceIdentifier>testni_uređaj1</DeviceIdentifier>
<DocIdentifier>testni_doktor1</DocIdentifier>
</Appointment>
</GetAppointmentResponse>
Element Descriptions:
Common:
| Element name |
Element description |
Mandatory |
| SuccessStatus |
References catalogue SuccessStatus |
YES |
| ErrorList |
List of errors |
If SuccessStatus is set to Fail |
| Appointment |
Appointment details |
If SuccessStatus is set to Success |
Appointment details:
| Element name |
Element description |
Mandatory |
| AppointmentUniqueIdentifier |
Appointment unique identifier |
YES |
| MedicalFacilityName |
Name of the facility where the exam was performed |
YES |
| MedicalFacilityAddress |
Address of the facility where the exam was performed |
YES |
| MedicalFacilityPhone |
Phone of the facility where the exam was performed |
NO |
| MedicalFacilityFax |
Fax of the facility where the exam was performed |
NO |
| MedicalFacilityEMail |
Email of the facility where the exam was performed |
NO |
| PatientNameAndSurname |
Patient first and last name |
YES |
| StreetName |
Street where the patient lives |
YES |
| StreetNumber |
Street number where the patient lives |
YES |
| CityName |
Name of the city patient lives in |
YES |
| CityPostalCode |
Postal code of the city patient lives in |
YES |
| DistrictCode |
Code of the district patient lives in |
NO |
| PatientUniqueIdentifier |
Unique identifier of the patient (EMŠO) |
NO |
| PatientInsuranceIdentifier |
Insurance identifier of the patient (KZZ) |
YES |
| PatientPhone |
Patient phone |
NO |
| PatientMobile |
Patient mobile |
NO |
| PatientEmail |
Patient email |
NO |
| MedicalProcedureName |
Medical procedure name |
YES |
| AppointmentDateTime |
Appointment date and time |
NO |
| SiteDescription |
Adress/description of the location where medical procedure (VZS) is performed (i.e. “Bolnišnica dr. Petra Držaja, Vodnikova 62, 1000 Ljubljana”) |
NO |
| MedicalFacilityNotes |
Notes sent by the hospital ordering system for booked appointment |
NO |
| ResponseCode |
References catalogue ResponseCodeType |
YES |
| HOSIdentifier |
Unique identifier of the reservation in the facility |
NO |
| HealthcareProviderIndex |
Medical facility code (BPI) |
YES |
| HealthcareProviderSpecificIndex |
Medical facility specific code (Used when multiple software vendors maintain the IS of the same facility) |
NO |
| ReferralUniqueIdentifier |
Referral unique identifier |
YES |
| OldReferralUniqueIdentifier |
Previous referral unique identifier |
NO |
| AppointmentStatus |
References catalogue AppointmentStatusType |
YES |
| CancelledBy |
Unique identifier (BPI) of the person which cancelled the appointment |
NO |
| CancellationReasonCode |
Cancellation reason code (References catalogue AppointmentCancellationReasonType) |
NO |
| CancellationReasonDescription |
Additional notes about the cancellation (mandatory for reason Ostalo) |
NO |
| CancelReferralFacilityCode |
Code of the facility that cancelled the appointment |
NO |
| CancelReferralFacilitySpecificCode |
Specific code of the facility that cancelled the appointment |
NO |
| MedicalProcedureCode |
Medical procedure unique identifier (VZS) |
YES |
| ControlExam |
Flag indicating if the medical procedure is control exam |
YES |
| RequestedByPatient |
Flag indicating if appointment is requested by patient |
NO |
| RequestedByPatientCode |
References catalogue RequestedByPatientType |
NO |
| MedicallyConditioned |
References catalogue MedicallyConditionedType |
NO |
| WantsSpecificDoctor |
True or False. Indicates if the appointment was selected based on the doctor performing the medical procedure |
YES |
| WasInformedOfOthers |
True or False. Indicates if the patient was aware of other earlier appointments (if they existed at the time when the reservation was made). Used when the selected appointment is outside of the legal boundaries for medical procedure |
YES |
| MedicalActivityList |
Code list of Doctors medical activities |
NO |
| CancellationDateTime |
Date and time when the appointment is cancelled |
Only if appointment is cancelled |
| RealisationDateTime |
Date and time of appointment realisation |
Only if appointment realisation exists |
| OfficeAddress |
Address of location where procedure can be made |
NO |
| UrgencyType |
Urgency type code (References catalogue UrgencyCodeType) |
NO |
| ReasonForChangingUrgencyType |
Reason for changing starting urgency type to new urgency type of appointment |
Only if starting urgency type was changed |
| DocumentTypeCode |
Type of document (Referral or Work order) (References catalogue DocumentType) |
NO (if is empty then is Referral) |
| CareTeamIdentifier |
Care team identifier |
NO |
| LocationIdentifier |
Ambulance/room where the medical procedure is being performed |
NO |
| DeviceIdentifier |
Device identifier |
NO |
| DocIdentifier |
Doctor identifier |
NO |
4.19 GetAppointmentsForPatient
Method used to get all the appointments for a patient.
It is mandatory to provide the patient insurance identifier (KZZ).
Other parameters are used to narrow the search.
GetAppointmentsForPatientRequest
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="GetAppointmentsForPatientRequest">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="ApiKey" type="NonEmptyString" />
<xs:element minOccurs="1" maxOccurs="1" name="PatientInsuranceIdentifier" type="PatientInsIdType" />
<xs:element minOccurs="0" maxOccurs="1" name="MedicalProcedureCode" type="MedicalProcedureCodeType" />
<xs:element minOccurs="0" maxOccurs="1" name="ReferralUniqueIdentifier" type="ReferralUidType" />
<xs:element minOccurs="0" maxOccurs="1" name="AppointmentStatus" type="AppointmentStatusType" />
<xs:element minOccurs="0" maxOccurs="1" name="DateFrom" type="xs:dateTime" />
<xs:element minOccurs="0" maxOccurs="1" name="DateTo" type="xs:dateTime" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<GetAppointmentsForPatientRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ApiKey>test</ApiKey>
<PatientInsuranceIdentifier>037676075</PatientInsuranceIdentifier>
<MedicalProcedureCode>1053P</MedicalProcedureCode>
<ReferralUniqueIdentifier>2020022600017</ReferralUniqueIdentifier>
<AppointmentStatus>CONF</AppointmentStatus>
<DateFrom>2020-05-15T00:00:00</DateFrom>
<DateTo>2020-10-15T00:00:00</DateTo>
</GetAppointmentsForPatientRequest>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| ApiKey |
Application key of the application making the request |
YES |
| PatientInsuranceIdentifier |
Patient insurance identifier (KZZ) |
YES |
| ReferralUniqueIdentifier |
Referral unique identifier |
NO |
| MedicalProcedureCode |
Medical procedure unique identifier (VZS) |
NO |
| AppointmentStatus |
References catalogue AppointmentStatusType |
NO |
| DateFrom |
Fetch all appointments from this date |
NO |
| DateTo |
Fetch all appointments till this date |
NO |
GetAppointmentsForPatientResponse
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="AppointmentSummary.xsd" />
<xs:element name="Appointment" type="AppointmentSummary" />
<xs:element name="Appointments">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="Appointment" />
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="GetAppointmentsForPatientResponse">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="SuccessStatus" type="SuccessStatusType" />
<xs:element minOccurs="0" maxOccurs="1" name="ErrorList" type="ErrorListType"/>
<xs:element minOccurs="0" maxOccurs="1" ref="Appointments" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<GetAppointmentsForPatientResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SuccessStatus>1</SuccessStatus>
<Appointments>
<Appointment>
<AppointmentUniqueIdentifier>738467216643424</AppointmentUniqueIdentifier>
<MedicalFacilityName>Testna Ustanova</MedicalFacilityName>
<MedicalFacilityAddress>Štefanova 5</MedicalFacilityAddress>
<MedicalFacilityPhone>01-478 6098</MedicalFacilityPhone>
<MedicalFacilityFax>01-478 6099</MedicalFacilityFax>
<MedicalFacilityEMail>test@test.si</MedicalFacilityEMail>
<PatientNameAndSurname>Ivica Kostelic</PatientNameAndSurname>
<StreetName>Ljubljanska cesta</StreetName>
<StreetNumber>2</StreetNumber>
<CityName>Novo mesto</CityName>
<CityPostalCode>8000</CityPostalCode>
<DistrictCode>085</DistrictCode>
<PatientUniqueIdentifier>1202003898747</PatientUniqueIdentifier>
<PatientInsuranceIdentifier>123456789</PatientInsuranceIdentifier>
<PatientPhone>015555879</PatientPhone>
<PatientMobile>031555879</PatientMobile>
<PatientEmail>ivica.kostelic@mail.com</PatientEmail>
<MedicalProcedureName>Klinicno genetski pregled – prvi</MedicalProcedureName>
<AppointmentDateTime>2014-03-13T18:00:00</AppointmentDateTime>
<SiteDescription>Hospital 54321</SiteDescription>
<MedicalFacilityNotes>No data</MedicalFacilityNotes>
<ResponseCode>02</ResponseCode>
<HOSIdentifier>4953</HOSIdentifier>
<HealthcareProviderIndex>12345</HealthcareProviderIndex>
<HealthcareProviderSpecificIndex>12345A</HealthcareProviderSpecificIndex>
<ReferralUniqueIdentifier>2014012900038</ReferralUniqueIdentifier>
<OldReferralUniqueIdentifier>2014012500043</OldReferralUniqueIdentifier>
<AppointmentStatus>CANC</AppointmentStatus>
<CancelledBy>12345</CancelledBy>
<CancellationReasonCode>13</CancellationReasonCode>
<CancellationReasonDescription>Bolezen</CancellationReasonDescription>
<CancelReferralFacilityCode>12345</CancelReferralFacilityCode>
<CancelReferralFacilitySpecificCode>12345A</CancelReferralFacilitySpecificCode>
<CancellationDateTime>2019-03-01T00:00:00</CancellationDateTime>
<RealisationDateTime>2019-03-01T00:00:00</RealisationDateTime>
<Urgencytype>3</Urgencytype>
<DocumentTypeCode>0</DocumentTypeCode>
<CareTeamIdentifier>testni_tim1</CareTeamIdentifier>
<LocationIdentifier>testna_lokacija1</LocationIdentifier>
<DeviceIdentifier>testni_uređaj1</DeviceIdentifier>
<DocIdentifier>testni_doktor1</DocIdentifier>
</Appointment>
</Appointments>
</GetAppointmentsForPatientResponse>
Element Descriptions:
Common:
| Element name |
Element description |
Mandatory |
| SuccessStatus |
References catalogue SuccessStatus |
YES |
| ErrorList |
List of errors |
If SuccessStatus is set to Fail |
| Appointments |
Appointments list |
If SuccessStatus is set to Success |
Appointment details:
| Element name |
Element description |
Mandatory |
| AppointmentUniqueIdentifier |
Appointment unique identifier |
YES |
| MedicalFacilityName |
Name of the facility where the exam was performed |
YES |
| MedicalFacilityAddress |
Address of the facility where the exam was performed |
YES |
| MedicalFacilityPhone |
Phone of the facility where the exam was performed |
NO |
| MedicalFacilityFax |
Fax of the facility where the exam was performed |
NO |
| MedicalFacilityEMail |
Email of the facility where the exam was performed |
NO |
| PatientNameAndSurname |
Patient first and last name |
YES |
| StreetName |
Street where the patient lives |
YES |
| StreetNumber |
Street number where the patient lives |
YES |
| CityName |
Name of the city patient lives in |
YES |
| CityPostalCode |
Postal code of the city patient lives in |
YES |
| DistrictCode |
Code of the district patient lives in |
NO |
| PatientUniqueIdentifier |
Unique identifier of the patient (EMŠO) |
NO |
| PatientInsuranceIdentifier |
Insurance identifier of the patient (KZZ) |
YES |
| PatientPhone |
Patient phone |
NO |
| PatientMobile |
Patient mobile |
NO |
| PatientEmail |
Patient email |
NO |
| MedicalProcedureName |
Medical procedure name |
YES |
| AppointmentDateTime |
Appointment date and time |
NO |
| SiteDescription |
Adress/description of the location where medical procedure (VZS) is performed (i.e. “Bolnišnica dr. Petra Držaja, Vodnikova 62, 1000 Ljubljana”) |
NO |
| MedicalFacilityNotes |
Notes sent by the hospital ordering system for booked appointment (visible on the order confirmation, i.e. “Order by phone exclusively with electronic referral”) |
NO |
| ResponseCode |
References catalogue ResponseCodeType |
YES |
| HOSIdentifier |
Unique identifier of the reservation in the facility |
NO |
| HealthcareProviderIndex |
Medical facility code (BPI) |
YES |
| HealthcareProviderSpecificIndex |
Medical facility specific code (Used when multiple software vendors maintain the IS of the same facility) |
Only if exists |
| ReferralUniqueIdentifier |
Referral unique identifier |
YES |
| OldReferralUniqueIdentifier |
Previous referral unique identifier |
NO |
| AppointmentStatus |
References catalogue AppointmentStatusType |
YES |
| CancelledBy |
Unique identifier (BPI) of the person which cancelled the appointment |
NO |
| CancellationReasonCode |
Cancellation reason code (References catalogue AppointmentCancellationReasonType) |
NO |
| CancellationReasonDescription |
Additional notes about the cancellation (mandatory for reason Ostalo) |
NO |
| CancelReferralFacilityCode |
Code of the facility that cancelled the appointment |
NO |
| CancelReferralFacilitySpecificCode |
Specific code of the facility that cancelled the appointment |
NO |
| MedicalProcedureCode |
Medical procedure unique identifier (VZS) |
YES |
| ControlExam |
Flag indicating if the medical procedure is control exam |
YES |
| RequestedByPatient |
Flag indicating if appointment is requested by patient |
NO |
| RequestedByPatientCode |
References catalogue RequestedByPatientType |
NO |
| MedicallyConditioned |
References catalogue MedicallyConditionedType |
NO |
| WantsSpecificDoctor |
True or False. Indicates if the appointment was selected based on the doctor performing the medical procedure |
YES |
| WasInformedOfOthers |
True or False. Indicates if the patient was aware of other earlier appointments (if they existed at the time when the reservation was made). Used when the selected appointment is outside of the legal boundaries for medical procedure |
YES |
| MedicalActivityList |
Code list of Doctors medical activities |
NO |
| CancellationDateTime |
Date and time when the appointment is cancelled |
Only if appointment is cancelled |
| RealisationDateTime |
Date and time of appointment realisation |
Only if appointment realisation exists |
| OfficeAddress |
Address of location where procedure can be made |
NO |
| UrgencyType |
Urgency type code (References catalogue UrgencyCodeType) |
NO |
| ReasonForChangingUrgencyType |
Reason for changing starting urgency type to new urgency type of appointment |
Only if starting urgency type was changed |
| DocumentTypeCode |
Type of document (Referral or Work order) (References catalogue DocumentType) |
NO (if is empty then is Referral) |
| CareTeamIdentifier |
Care team identifier |
NO |
| LocationIdentifier |
Ambulance/room where the medical procedure is being performed |
NO |
| DeviceIdentifier |
Device identifier |
NO |
| DocIdentifier |
Doctor identifier |
NO |
4.20 CreateTask
Method used to create a task. This method can only be called by the doctor who has one of the roles: PRIMARNI ZDRAVNIK, ZDRAVNIK SPECIALIST or ZDRAVNIK SPECIALIST NAPOTOVALEC.
The method can be called only for referrals which are for the first time in status Scheduled (Vpisana).
If method is called by the doctor which issued the referral, he can create only Consultation type of task.
If method is called by the specialist and he is not issued referral, he must be employee of the medical facility in which appointment is scheduled.
There are 2 types of task:
Update referral – when there is the need to update the referral with more details (the doctor which issued the referral will receive an update request). It is only possible to create a task for up to 5 days before the appointment date
Consultation – when the doctor would like to get more information
CreateTaskRequest
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="CreateTaskRequest">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="ApiKey" type="NonEmptyString" />
<xs:element minOccurs="0" maxOccurs="1" name="HealthcareProviderIndex" type="BPIType" />
<xs:element minOccurs="1" maxOccurs="1" name="ReferralUniqueIdentifier" type="ReferralUidType" />
<xs:element minOccurs="1" maxOccurs="1" name="PatientInsuranceIdentifier" type="PatientInsIdType" />
<xs:element minOccurs="1" maxOccurs="1" name="RequestType" type="TaskType" />
<xs:element minOccurs="0" maxOccurs="1" name="HealthcareProviderSpecificIndex" type="BPIspecificType" />
<xs:element minOccurs="1" maxOccurs="1" name="RequestDescription" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="Email" type="EmailType" />
<xs:element minOccurs="0" maxOccurs="1" name="IsSpecialist" type="xs:boolean" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<CreateTaskRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ApiKey>test</ApiKey>
<HealthcareProviderIndex>10000</HealthcareProviderIndex>
<ReferralUniqueIdentifier>1234567891234</ReferralUniqueIdentifier>
<PatientInsuranceIdentifier>123456789</PatientInsuranceIdentifier>
<RequestType>1</RequestType>
<RequestDescription>description</RequestDescription>
</CreateTaskRequest>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| ApiKey |
Application key of the application making the request |
YES |
| HealthcareProviderIndex |
Medical facility code (BPI) – facility where specialist works |
Only for the specialist |
| ReferralUniqueIdentifier |
Referral unique identifier |
YES |
| PatientInsuranceIdentifier |
Patient insurance identifier (KZZ) |
YES |
| RequestType |
Request type (References catalogue TaskType) – specialist can only use UpdateReferral or Consultation |
YES |
| HealthcareProviderSpecificIndex |
Medical facility specific code (Used when multiple software vendors maintain the IS of the same facility) |
Only if exists |
| RequestDescription |
Additional notes about the request |
YES |
| Email |
Specialist email, if provided the specialist will be notified when the request is processed |
NO |
| IsSpecialist |
In case when user is both primary doctor and specialist (have both roles in security token) this can be used to filter tasks: true – specialist, false – primary, no value – both |
NO |
CreateTaskResponse
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="CreateTaskResponse">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="SuccessStatus" type="SuccessStatusType" />
<xs:element minOccurs="0" maxOccurs="1" name="ErrorList" type="ErrorListType" />
<xs:element minOccurs="0" maxOccurs="1" name="TaskUniqueIdentifier" type="NonEmptyString" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<CreateTaskResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SuccessStatus>1</SuccessStatus>
<TaskUniqueIdentifier>123456789123456</TaskUniqueIdentifier>
</CreateTaskResponse>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| SuccessStatus |
References catalogue SuccessStatus |
YES |
| ErrorList |
List of errors |
If SuccessStatus is set to Fail |
| TaskUniqueIdentifier |
Task unique identifier |
If SuccessStatus is set to Success |
4.21 SendMessage
Method used to exchange messages between doctor who issued the referral and doctor of the medical facility in which appointment is scheduled.
This method can only be called by the doctor who has one of the roles: PRIMARNI ZDRAVNIK, ZDRAVNIK SPECIALIST or ZDRAVNIK SPECIALIST NAPOTOVALEC.
In order to SendMessage, specialist or primary doctor has to create a task.
After that all the other messages regarding a specific patient/referral are exchanged within this method.
SendMessageRequest
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="SendMessageRequest">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="ApiKey" type="NonEmptyString" />
<xs:element minOccurs="0" maxOccurs="1" name="HealthcareProviderIndex" type="BPIType" />
<xs:element minOccurs="0" maxOccurs="1" name="HealthcareProviderSpecificIndex" type="BPIspecificType" />
<xs:element minOccurs="1" maxOccurs="1" name="Message" type=" NonEmptyString" />
<xs:element minOccurs="1" maxOccurs="1" name="TaskUniqueIdentifier" type="NonEmptyString" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<SendMessageRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ApiKey>test</ApiKey>
<Message>Odgovor za stranku</Message>
<TaskUniqueIdentifier>22</TaskUniqueIdentifier>
</SendMessageRequest>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| ApiKey |
Application key of the application making the request |
YES |
| HealthcareProviderIndex |
Medical facility code (BPI) |
Only for specialist |
| HealthcareProviderSpecificIndex |
Medical facility specific code (Used when multiple software vendors maintain the IS of the same facility) |
Only if exists |
| Message |
Message text |
YES |
| TaskUniqueIdentifier |
Task unique identifier |
YES |
SendMessageResponse
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="SendMessageResponse">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="SuccessStatus" type="SuccessStatusType" />
<xs:element minOccurs="0" maxOccurs="1" name="ErrorList" type="ErrorListType" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<SendMessageResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SuccessStatus>1</SuccessStatus>
</SendMessageResponse>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| SuccessStatus |
References catalogue SuccessStatus |
YES |
| ErrorList |
List of errors |
If SuccessStatus is set to Fail |
4.22 UpdateUrgencyTypeCode
Only specialist can call this method to update the urgency type for a referral.
The method can be called only for referrals which are in status Scheduled (Vpisana).
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="UpdateUrgencyTypeCodeRequest">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="ApiKey" type="NonEmptyString" />
<xs:element minOccurs="1" maxOccurs="1" name="HealthcareProviderIndex" type="BPIType" />
<xs:element minOccurs="0" maxOccurs="1" name="HealthcareProviderSpecificIndex" type="BPIspecificType" />
<xs:element minOccurs="1" maxOccurs="1" name="NewUrgencyType" type="UrgencyTypeForRefType" />
<xs:element minOccurs="1" maxOccurs="1" name="ReferralUniqueIdentifier" type="ReferralUidType" />
<xs:element minOccurs="1" maxOccurs="1" name="PatientInsuranceIdentifier" type="PatientInsIdType" />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“ReasonForChangingUrgencyType“ type=“xs:string“ />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<UpdateUrgencyTypeCodeRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ApiKey>api</ApiKey>
<HealthcareProviderIndex>12345</HealthcareProviderIndex>
<NewUrgencyType>2</NewUrgencyType>
<ReferralUniqueIdentifier>2014013100001</ReferralUniqueIdentifier>
<PatientInsuranceIdentifier>123456789</PatientInsuranceIdentifier>
<ReasonForChangingUrgencyType>test</ReasonForChangingUrgencyType>
</UpdateUrgencyTypeCodeRequest>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| ApiKey |
Application key of the application making the request |
YES |
| HealthcareProviderIndex |
Medical facility code (BPI) |
YES |
| HealthcareProviderSpecificIndex |
Medical facility specific code (Used when multiple software vendors maintain the IS of the same facility) |
Only if exists |
| NewUrgencyType |
References catalogue UrgencyCodeType |
YES |
| ReferralUniqueIdentifier |
Referral unique identifier |
YES |
| PatientInsuranceIdentifier |
Patient insurance identifier (KZZ) |
YES |
UpdateUrgencyTypeCodeResponse
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="UpdateUrgencyTypeCodeResponse">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="SuccessStatus" type="SuccessStatusType"/>
<xs:element minOccurs="0" maxOccurs="1" name="ErrorList" type="ErrorListType"/>
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<UpdateUrgencyTypeCodeResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SuccessStatus>2</SuccessStatus>
<ErrorList>
<Error>
<Code>0002</Code>
<Description>test1</Description>
</Error>
<Error>
<Code>2</Code>
<Description>test2</Description>
</Error>
</ErrorList>
</UpdateUrgencyTypeCodeResponse>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| SuccessStatus |
References catalogue SuccessStatus |
YES |
| ErrorList |
List of errors |
If SuccessStatus is set to Fail |
4.23 GetTasksList
Method that allows the primary doctor and specialist to get tasks they have been working on.
Primary filter that is always applied (not in request) is doctors BPI from security token.
If all the filters are omitted, the system will return the tasks created within the last 30 days.
GetTaskListRequest
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="GetTaskListRequest">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="ApiKey" type="NonEmptyString" />
<xs:element minOccurs="0" maxOccurs="1" name="HealthcareProviderIndex" type="BPIType" />
<xs:element minOccurs="0" maxOccurs="1" name="HealthcareProviderSpecificIndex" type="BPIspecificType" />
<xs:element minOccurs="0" maxOccurs="1" name="ReferralUniqueIdentifier" type="ReferralUidType" />
<xs:element minOccurs="0" maxOccurs="1" name="RequestType" type="TaskType" />
<xs:element minOccurs="0" maxOccurs="1" name="TaskStatus" type="TaskStatusType" />
<xs:element minOccurs="0" maxOccurs="1" name="DateFrom" type="xs:dateTime" />
<xs:element minOccurs="0" maxOccurs="1" name="DateTo" type="xs:dateTime" />
<xs:element minOccurs="0" maxOccurs="1" name="TaskUniqueIdentifier" type="NonEmptyString" />
<xs:element minOccurs="0" maxOccurs="1" name="IsSpecialist" type="xs:boolean" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<GetTaskListRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ApiKey>1d75ed19-1499-47ce-92cf-2377d01f9ade</ApiKey>
<ReferralUniqueIdentifier>2014013100001</ReferralUniqueIdentifier>
<RequestType>5</RequestType>
<TaskStatus>1</TaskStatus>
<IsSpecialist>true</IsSpecialist>
</GetTaskListRequest>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| ApiKey |
Application key of the application making the request |
YES |
| HealthcareProviderIndex |
Medical facility code (BPI) |
Only for specialist |
| HealthcareProviderSpecificIndex |
Medical facility specific code (Used when multiple software vendors maintain the IS of the same facility) |
Only if exists |
| ReferralUniqueIdentifier |
Referral unique identifier |
NO |
| RequestType |
References catalogue [TaskType](#tasktype |
NO |
| TaskStatus |
References catalogue TaskStatusType |
NO |
| DateFrom |
Fetch all tasks from this date |
NO |
| DateTo |
Fetch all tasks till this date |
NO |
| TaskUniqueIdentifier |
Task unique identifier |
NO |
| IsSpecialist |
In case when user is both primary doctor and specialist (have both roles in security token) this can be used to filter tasks: true – specialist, false – primary, no value – both |
NO |
GetTaskListResponse
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="Task">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="ReferralUniqueIdentifier" type="ReferralUidType" />
<xs:element minOccurs="1" maxOccurs="1" name="PatientInsuranceIdentifier" type="PatientInsIdType" />
<xs:element minOccurs="1" maxOccurs="1" name="RequestType" type="TaskType" />
<xs:element minOccurs="1" maxOccurs="1" name="TaskStatus" type="TaskStatusType" />
<xs:element minOccurs="1" maxOccurs="1" name="TaskUniqueIdentifier" type="xs:string" />
<xs:element minOccurs="1" maxOccurs="1" name="DateCreated" type="xs:dateTime" />
<xs:element minOccurs="0" maxOccurs="1" ref="MessageList"/>
</xs:all>
</xs:complexType>
</xs:element>
<xs:element name="MessageList">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="TaskMessage"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="TaskMessage">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="SenderBpi" type="NonEmptyString" />
<xs:element minOccurs="1" maxOccurs="1" name="Message" type="NonEmptyString" />
<xs:element minOccurs="1" maxOccurs="1" name="MessageDate" type="xs:dateTime" />
</xs:all>
</xs:complexType>
</xs:element>
<xs:element name="TasksList">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="1" maxOccurs="unbounded" ref="Task" />
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="GetTaskListResponse">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="SuccessStatus" type="SuccessStatusType" />
<xs:element minOccurs="0" maxOccurs="1" name="ErrorList" type="ErrorListType" />
<xs:element minOccurs="0" maxOccurs="1" ref="TasksList" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<GetTaskListResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SuccessStatus>1</SuccessStatus>
<TasksList>
<Task>
<ReferralUniqueIdentifier>2014013100001</ReferralUniqueIdentifier>
<PatientInsuranceIdentifier>123456789</PatientInsuranceIdentifier>
<RequestType>2</RequestType>
<TaskStatus>1</TaskStatus>
<TaskUniqueIdentifier>2</TaskUniqueIdentifier>
<DateCreated>2019-01-01T00:00:00</DateCreated>
<MessageList>
<TaskMessage>
<SenderBpi>12345</SenderBpi>
<Message>Poruka1</Message>
<MessageDate>2019-01-01T00:00:00</MessageDate>
</TaskMessage>
<TaskMessage>
<SenderBpi>50001</SenderBpi>
<Message>Poruka2</Message>
<MessageDate>2019-01-01T00:00:00</MessageDate>
</TaskMessage>
</MessageList>
</Task>
<Task>
<ReferralUniqueIdentifier>2014013100001</ReferralUniqueIdentifier>
<PatientInsuranceIdentifier>123456789</PatientInsuranceIdentifier>
<RequestType>2</RequestType>
<TaskStatus>1</TaskStatus>
<TaskUniqueIdentifier>3</TaskUniqueIdentifier>
<DateCreated>2019-01-01T00:00:00</DateCreated>
<MessageList>
<TaskMessage>
<SenderBpi>12345</SenderBpi>
<Message>Poruka1</Message>
<MessageDate>2019-01-01T00:00:00</MessageDate>
</TaskMessage>
<TaskMessage>
<SenderBpi>50001</SenderBpi>
<Message>Poruka2</Message>
<MessageDate>2019-01-01T00:00:00</MessageDate>
</TaskMessage>
</MessageList>
</Task>
</TasksList>
</GetTaskListResponse>
Element Descriptions:
Common:
| Element name |
Element description |
Mandatory |
| SuccessStatus |
References catalogue SuccessStatus |
YES |
| ErrorList |
List of errors |
If SuccessStatus is set to Fail |
| TaskList |
Tasks list |
If SuccessStatus is set to Success |
Task details:
| Element name |
Element description |
Mandatory |
| ReferralUniqueIdentifier |
Referral unique identifier |
YES |
| PatientInsuranceIdentifier |
Patient insurance identifier (KZZ) |
YES |
| RequestType |
References catalogue TaskType |
YES |
| TaskStatus |
References catalogue TaskStatusType |
YES |
| TaskUniqueIdentifier |
Task unique identifier |
YES |
| DateCreated |
Date when the task was created |
YES |
| MessageList |
List of messages exchanged between primary doctor and specialist |
If any message exists |
Message details:
| Element name |
Element description |
Mandatory |
| SenderBpi |
Sender BPI |
YES |
| Message |
Message |
YES |
| MessageDate |
Date when message is sent |
YES |
4.24 GetReferralChanges
With this method the primary doctor can get all the referrals that he has issued and someone else has modified.
If specialist changes the urgency type or cancels the referral, the primary doctor will be able to see every change with this method.
GetReferralChangesRequest
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="GetReferralChangesRequest">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="ApiKey" type="NonEmptyString" />
<xs:element minOccurs="0" maxOccurs="1" name="ReferralUniqueIdentifier" type="ReferralUidType" />
<xs:element minOccurs="0" maxOccurs="1" name="PatientInsuranceIdentifier" type="PatientInsIdType" />
<xs:element minOccurs="0" maxOccurs="1" name="ChangeType" type="TaskType" />
<xs:element minOccurs="0" maxOccurs="1" name="DateFrom" type="xs:dateTime" />
<xs:element minOccurs="0" maxOccurs="1" name="DateTo" type="xs:dateTime" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<GetReferralChangesRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ApiKey>1d75ed19-1499-47ce-92cf-2377d01f9ade</ApiKey>
<ReferralUniqueIdentifier>2014013100001</ReferralUniqueIdentifier>
<ChangeType>3</ChangeType>
</GetReferralChangesRequest>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| ApiKey |
Application key of the application making the request |
YES |
| ReferralUniqueIdentifier |
Referral unique identifier |
NO |
| PatientInsuranceIdentifier |
Patient insurance identifier (KZZ) |
NO |
| ChangeType |
References catalogue TaskType |
NO |
| DateFrom |
Fetch all referral changes from this date |
NO |
| DateTo |
Fetch all referral changes till this date |
NO |
GetReferrralChangesResponse
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="ReferralChange">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="ReferralUniqueIdentifier" type="ReferralUidType" />
<xs:element minOccurs="1" maxOccurs="1" name="ChangeType" type="TaskType" />
<xs:element minOccurs="0" maxOccurs="1" name="DateChange" type="xs:dateTime" />
<xs:element minOccurs="0" maxOccurs="1" name="OldUrgencyType" type="UrgencyTypeForRefType" />
<xs:element minOccurs="0" maxOccurs="1" name="NewUrgencyType" type="UrgencyTypeForRefType" />
<xs:element minOccurs="0" maxOccurs="1" name="CancelledBy" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="CancellationReferralReasonType" type="ReferralCancellationReasonType" />
<xs:element minOccurs="0" maxOccurs="1" name="CancelReferralDescription" type="xs:string" />
</xs:all>
</xs:complexType>
</xs:element>
<xs:element name="ReferralChanges">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="1" maxOccurs="unbounded" ref="ReferralChange" />
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="GetReferralChangesResponse">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="SuccessStatus" type="SuccessStatusType" />
<xs:element minOccurs="0" maxOccurs="1" name="ErrorList" type="ErrorListType" />
<xs:element minOccurs="0" maxOccurs="1" ref="ReferralChanges" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<GetReferralChangesResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SuccessStatus>1</SuccessStatus>
<ReferralChanges>
<ReferralChange>
<ReferralUniqueIdentifier>2014013100001</ReferralUniqueIdentifier>
<ChangeType>4</ChangeType>
<OldUrgencyType>2</OldUrgencyType>
<NewUrgencyType>1</NewUrgencyType>
</ReferralChange>
<ReferralChange>
<ReferralUniqueIdentifier>2014013100001</ReferralUniqueIdentifier>
<ChangeType>4</ChangeType>
<OldUrgencyType>2</OldUrgencyType>
<NewUrgencyType>1</NewUrgencyType>
</ReferralChange>
</ReferralChanges>
</GetReferralChangesResponse>
Element Descriptions:
Common:
| Element name |
Element description |
Mandatory |
| SuccessStatus |
References catalogue SuccessStatus |
YES |
| ErrorList |
List of errors |
If SuccessStatus is set to Fail |
| ReferralChanges |
List of referral changes |
If any exists |
Referral changes:
| Element name |
Element description |
Mandatory |
| ReferralUniqueIdentifier |
Referral unique identifier |
YES |
| ChangeType |
References catalogue TaskType |
YES |
| DateChange |
Date when the change was made |
NO |
| OldUrgencyType |
Old urgency type code (References catalogue UrgencyCodeType) |
If urgency type was changed |
| NewUrgencyType |
New urgency type code (References catalogue UrgencyCodeType) |
If urgency type was changed |
| CancelledBy |
Unique identifier (BPI) of the person which cancelled the referral |
If referral was cancelled |
| CancellationReferralReasonType |
References catalogue ReferralCancellationReasonType |
If referral was cancelled |
| CancelReferralDescription |
Additional notes regarding the cancellation |
If referral was cancelled and description exists |
4.25 CloseTask
Method used to close a task. Both specialist and primary doctor can call this method.
Task can close only doctor who has issued the referral or doctor of the medical facility in which appointment is scheduled.
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="CloseTaskRequest">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="ApiKey" type="NonEmptyString" />
<xs:element minOccurs="1" maxOccurs="1" name="TaskUniqueIdentifier" type="NonEmptyString" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<CloseTaskRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ApiKey>1d75ed19-1499-47ce-92cf-2377d01f9ade</ApiKey>
<TaskUniqueIdentifier>1111</TaskUniqueIdentifier>
</CloseTaskRequest>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| ApiKey |
Application key of the application making the request |
YES |
| TaskUniqueIdentifier |
Task unique identifier |
YES |
CloseTaskResponse
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="CloseTaskResponse">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="SuccessStatus" type="SuccessStatusType" />
<xs:element minOccurs="0" maxOccurs="1" name="ErrorList" type="ErrorListType" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<CloseTaskResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SuccessStatus>1</SuccessStatus>
</CloseTaskResponse>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| SuccessStatus |
References catalogue SuccessStatus |
YES |
| ErrorList |
List of errors |
If SuccessStatus is set to Fail |
4.26 GetFreeSlotForProcedureCOS
This method returns first slots of medical facilities for specific medical procedure.
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="GetFreeSlotsForProcedureRequestCOS">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="ApiKey" type="NonEmptyString" />
<xs:element minOccurs="0" maxOccurs="1" name="RegionCode" type="xs:string" />
<xs:element minOccurs="1" maxOccurs="1" name="MedicalProcedureCode" type="MedicalProcedureCodeType" />
<xs:element minOccurs="1" maxOccurs="1" name="UrgencyTypeCode" type="UrgencyTypeForAppType" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<GetFreeSlotsForProcedureRequestCOS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ApiKey>test</ApiKey>
<MedicalProcedureCode>1053P</MedicalProcedureCode>
<UrgencyTypeCode>2</UrgencyTypeCode>
</GetFreeSlotsForProcedureRequestCOS>
Element Descriptions:
| Element name |
Element description |
Mandatory / Condition |
| ApiKey |
Application key of the application making the request |
YES |
| RegionCode |
References catalogue StatisticalRegionCode |
NO |
| MedicalProcedureCode |
Medical procedure unique identifier (VZS) |
YES |
| UrgencyTypeCode |
Urgency type code (References catalogue UrgencyCodeType) |
YES |
GetFreeSlotsForProcedureResponseCOS
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="Office">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="Name" type="NonEmptyString" />
<xs:element minOccurs="0" maxOccurs="1" name="ResponseCodeRegular" type="ResponseCodeType" />
<xs:element minOccurs="0" maxOccurs="1" name="BlockSlotDateRegular" type="xs:dateTime" />
<xs:element minOccurs="0" maxOccurs="1" name="ResponseCodeUrgent" type="ResponseCodeType" />
<xs:element minOccurs="0" maxOccurs="1" name="BlockSlotDateUrgent" type="xs:dateTime" />
<xs:element minOccurs="0" maxOccurs="1" name="ResponseCodeVeryUrgent" type="ResponseCodeType" />
<xs:element minOccurs="0" maxOccurs="1" name="BlockSlotDateVeryUrgent" type="xs:dateTime" />
<xs:element minOccurs="0" maxOccurs="1" name="AdditionalNotes" type="NonEmptyString" />
</xs:all>
</xs:complexType>
</xs:element>
<xs:element name="OfficeList">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="Office" />
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="UrgencySlot">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="Urgency" type="UrgencyTypeForAppType" />
<xs:element minOccurs="1" maxOccurs="1" name="ResponseCode" type="ResponseCodeType" />
<xs:element minOccurs="0" maxOccurs="1" name="BlockSlotSize" type="xs:integer" />
<xs:element minOccurs="0" maxOccurs="1" name="FirstSlotDate" type="xs:dateTime" />
<xs:element minOccurs="0" maxOccurs="1" name="BlockSlotDate" type="xs:dateTime" />
</xs:all>
</xs:complexType>
</xs:element>
<xs:element name="UrgencyCodeList">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="1" maxOccurs="3" ref="UrgencySlot" />
</xs:sequence>
</xs:complexType>
<xs:unique name="UrgencyUnique">
<xs:selector xpath="UrgencySlot" />
<xs:field xpath="Urgency" />
</xs:unique>
</xs:element>
<xs:element name="FreeSlotForProcedure" nillable="true">
<xs:complexType>
<xs:all>
<xs:element minOccurs="0" maxOccurs="1" name="MedicalFacilityCode" type="BPIType" />
<xs:element minOccurs="0" maxOccurs="1" name="MedicalFacilityName" type="string" />
<xs:element minOccurs="0" maxOccurs="1" name="MedicalFacilitySpecificCode" type="BPIspecificType" />
<xs:element minOccurs="0" maxOccurs="1" name="MedicalProcedureCode" type="MedicalProcedureCodeType" />
<xs:element minOccurs="0" maxOccurs="1" ref="UrgencyCodeList" />
<xs:element minOccurs="0" maxOccurs="1" ref="OfficeList" />
<xs:element minOccurs="0" maxOccurs="1" name="RegionCode" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="OfficeWebAddress" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="OfficeBussinessHours" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="OfficeAddress" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="OfficeCity" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="OfficePostalCode" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="OfficeEMail" type="EmailType" />
<xs:element minOccurs="0" maxOccurs="1" name="OfficePhone" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="OfficeFax" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="AdditionalNotes" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="Active" type="xs:boolean" />
</xs:all>
</xs:complexType>
</xs:element>
<xs:element name="FreeSlotsForProcedureList" nillable="true">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="FreeSlotForProcedure"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="GetFreeSlotsForProcedureResponseCOS" nillable="true">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="1" maxOccurs="1" name="SuccessStatus" type="SuccessStatusType" />
<xs:element minOccurs="0" maxOccurs="1" name="ErrorList" type="ErrorListType" />
<xs:element minOccurs="0" maxOccurs="unbounded" ref="FreeSlotsForProcedureList" />
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<GetFreeSlotsForProcedureResponseCOS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SuccessStatus>1</SuccessStatus>
<FreeSlotsForProcedureList>
<FreeSlotForProcedure>
<MedicalFacilityCode>12345</MedicalFacilityCode>
<MedicalFacilityName>IN2 test</MedicalFacilityName>
<MedicalFacilitySpecificCode>12345A</MedicalFacilitySpecificCode>
<MedicalProcedureCode>1053P</MedicalProcedureCode>
<UrgencyCodeList>
<UrgencySlot>
<Urgency>2</Urgency>
<ResponseCode>01</ResponseCode>
<BlockSlotSize>4</BlockSlotSize>
<FirstSlotDate>2020-10-01T00:00:00</FirstSlotDate>
<BlockSlotDate>2020-10-05T00:00:00</BlockSlotDate>
</UrgencySlot>
<UrgencySlot>
<Urgency>3</Urgency>
<ResponseCode>05</ResponseCode>
<BlockSlotSize>4</BlockSlotSize>
<FirstSlotDate>2020-11-01T00:00:00</FirstSlotDate>
<BlockSlotDate>2020-11-03T00:00:00</BlockSlotDate>
</UrgencySlot>
<UrgencySlot>
<Urgency>4</Urgency>
<ResponseCode>01</ResponseCode>
<BlockSlotSize>4</BlockSlotSize>
<FirstSlotDate>2020-11-12T00:00:00</FirstSlotDate>
<BlockSlotDate>2020-11-13T00:00:00</BlockSlotDate>
</UrgencySlot>
</UrgencyCodeList>
<OfficeList>
<Office>
<Name>OfficeName1</Name>
<ResponseCodeRegular>01</ResponseCodeRegular>
<BlockSlotDateRegular>2020-11-01T00:00:00</BlockSlotDateRegular>
<ResponseCodeUrgent>02</ResponseCodeUrgent>
<BlockSlotDateUrgent>2020-10-01T00:00:00</BlockSlotDateUrgent>
<ResponseCodeVeryUrgent>01</ResponseCodeVeryUrgent>
<BlockSlotDateVeryUrgent>2020-11-12T00:00:00</BlockSlotDateVeryUrgent>
<AdditionalNotes>Notes1</AdditionalNotes>
</Office>
<Office>
<Name>OfficeName2</Name>
<BlockSlotDateRegular>2020-12-09T00:00:00</BlockSlotDateRegular>
<BlockSlotDateUrgent>2020-12-09T00:00:00</BlockSlotDateUrgent>
<BlockSlotDateVeryUrgent>2020-12-09T00:00:00</BlockSlotDateVeryUrgent>
<AdditionalNotes>Notes1</AdditionalNotes>
</Office>
</OfficeList>
<RegionCode>01</RegionCode>
<OfficeWebAddress>OfficeWeb.com</OfficeWebAddress>
<OfficeBussinessHours>08-20</OfficeBussinessHours>
<OfficeAddress>Ulica 5</OfficeAddress>
<OfficeCity>Zagreb</OfficeCity>
<OfficePostalCode>10000</OfficePostalCode>
<OfficeEMail>officemail@in2.hr</OfficeEMail>
<OfficePhone>01123456</OfficePhone>
<OfficeFax>01123457</OfficeFax>
<AdditionalNotes>Additional notes</AdditionalNotes>
</FreeSlotForProcedure>
</FreeSlotsForProcedureList>
</GetFreeSlotsForProcedureResponseCOS>
Element Descriptions:
Common:
| Element name |
Element description |
Mandatory |
| SuccessStatus |
References catalogue SuccessStatus |
YES |
| ErrorList |
List of errors |
If SuccessStatus is set to Fail |
| FreeSlotsForProcedureList |
List of free slots |
If SuccessStatus is set to Success and if any exists |
FreeSlot:
| Element name |
Element description |
Mandatory |
| MedicalFacilityCode |
Medical facility code (BPI) |
NO |
| MedicalFacilityName |
Medical facility name |
NO |
| MedicalFacilitySpecificCode |
Medical facility specific code (Used when multiple software vendors maintain the IS of the same facility) |
Only if exists |
| MedicalProcedureCode |
Unique identifier of the medical procedure (VZS) |
NO |
| UrgencyCodeList |
List of free slots per urgency code type |
NO |
| OfficeList |
List of doctors/departments |
NO |
| RegionCode |
|
NO |
| OfficeWebAddress |
Medical facility web address |
NO |
| OfficeBussinessHours |
Medical facility business hours |
NO |
| OfficeAddress |
Medical facility address |
NO |
| OfficeCity |
Medical facility city |
NO |
| OfficePostalCode |
Medical facility postal code |
NO |
| OfficeEMail |
Medical facility email |
NO |
| OfficePhone |
Medical facility phone number |
NO |
| OfficeFax |
Medical facility fax number |
NO |
| AdditionalNotes |
Additional notes about the facility (zVem web and the Čakalne dobe web displays this information) |
NO |
| Active |
Is appointment active |
NO |
UrgencySlot:
| Element name |
Element description |
Mandatory |
| Urgency |
Urgency type code (References catalogue UrgencyCodeType) |
YES |
| ResponseCode |
Code of the booked slot type (References catalogue ResponseCodeType) |
YES |
| BlockSlotSize |
Number of slots requested for urgency type code |
Yes for ResponseCode 01 and 02 |
| FirstSlotDate |
Date of the first available slot |
Yes for ResponseCode 01 and 02 |
| BlockSlotDate |
Date of the first available block slot |
Yes for ResponseCode 01 and 02 |
Office:
If the node is provided within the xml then name + at least one block slot date are mandatory
| Element name |
Element description |
Mandatory |
| Name |
Doctor/resource/department name |
YES |
| ResponseCodeRegular |
Code of the booked slot type (References catalogue ResponseCodeType); if no response code was sent default value 01 will be used |
NO |
| BlockSlotDateRegular |
Date of the first available block slot for regular urgency type |
NO |
| ResponseCodeUrgent |
Code of the booked slot type (References catalogue ResponseCodeType); if no response code was sent default value 01 will be used |
NO |
| BlockSlotDateUrgent |
Date of the first available block slot for urgent urgency type |
NO |
| ResponseCodeVeryUrgent |
Code of the booked slot type (References catalogue ResponseCodeType); if no response code was sent default value 01 will be used |
NO |
| BlockSlotDateVeryUrgent |
Date of the first available block slot for very urgent urgency type |
NO |
| AdditionalNotes |
Additional information about free block slot of one medical procedure (VZS) for the clinic (information about the clinic may differ from facility information). zVem web and the Čakalne dobe web displays this information |
NO |
4.27 GetPrereservationForProcedureCOS
Method used to create prereservations in the HOS during the process of booking a reservation.
The method internally calls GetPrereservationForProcedureHOS to fetch the current available terms in the facility based on the search details.
GetPrereservationsForProcedureRequestCOS
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="GetPrereservationsForProcedureRequestCOS">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="ApiKey" type="NonEmptyString" />
<xs:element minOccurs="1" maxOccurs="1" name="MedicalFacilityCode" type="BPIType" />
<xs:element minOccurs="0" maxOccurs="1" name="MedicalFacilitySpecificCode" type="BPIspecificType" />
<xs:element minOccurs="1" maxOccurs="1" name="MedicalProcedureCode" type="MedicalProcedureCodeType" />
<xs:element minOccurs="1" maxOccurs="1" name="BookerIdentifier" type="BookerIdentifierType" />
<xs:element minOccurs="1" maxOccurs="1" name="ReferralUniqueIdentifier" type="ReferralUidType" />
<xs:element minOccurs="1" maxOccurs="1" name="UrgencyType" type="UrgencyTypeForAppType" />
<xs:element minOccurs="1" maxOccurs="1" name="StartDate" type="xs:dateTime" />
<xs:element minOccurs="0" maxOccurs="1" name="PatientUniqueIdentifier" type="PatientUIdType" />
<xs:element minOccurs="1" maxOccurs="1" name="PatientInsuranceIdentifier" type="PatientInsIdType" />
<xs:element minOccurs="0" maxOccurs="1" name="PatientBirthDate" type="xs:dateTime" />
<xs:element minOccurs="0" maxOccurs="1" name="PatientGender" type="PatientGenderType" />
<xs:element minOccurs="0" maxOccurs="1" name="ReferralDiagnosis" type="ReferralDiagnosisType" />
<xs:element minOccurs="0" maxOccurs="1" name="BeforeAfterTime" type="xs:boolean"/>
<xs:element minOccurs="0" maxOccurs="1" name="Time" type="xs:string" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<GetPrereservationsForProcedureRequestCOS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ApiKey>test</ApiKey>
<MedicalFacilityCode>10000</MedicalFacilityCode>
<MedicalProcedureCode>1000</MedicalProcedureCode>
<BookerIdentifier>12345</BookerIdentifier>
<ReferralUniqueIdentifier>1234567891234</ReferralUniqueIdentifier>
<UrgencyType>2</UrgencyType>
<StartDate>2014-01-10T00:00:00</StartDate>
<PatientInsuranceIdentifier>123456789</PatientInsuranceIdentifier>
<PatientBirthDate>1990-01-10T00:00:00</PatientBirthDate>
<PatientGender>1</PatientGender>
<ReferralDiagnosis>I20</ReferralDiagnosis>
</GetPrereservationsForProcedureRequestCOS>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| ApiKey |
Application key of the application making the request |
YES |
| MedicalFacilityCode |
Medical facility code (BPI) |
YES |
| MedicalFacilitySpecificCode |
Medical facility specific code (Used when multiple software vendors maintain the IS of the same facility) |
Only if exists |
| MedicalProcedureCode |
Medical procedure unique identifier (VZS) |
YES |
| BookerIdentifier |
Unique identifier (BPI) of the person which made the reservation |
YES |
| ReferralUniqueIdentifier |
Referral unique identifier |
YES |
| UrgencyType |
Urgency type code (References catalogue UrgencyCodeType) |
YES |
| StartDate |
Search for terms from this date onward |
YES |
| PatientUniqueIdentifier |
Unique identifier of the patient (EMŠO) |
NO |
| PatientInsuranceIdentifier |
Insurance identifier of the patient (KZZ) |
YES |
| PatientBirthDate |
Patient birth date |
NO |
| PatientGender |
Patient gender (References catalogue PatientGenderType) |
NO |
| ReferralDiagnosis |
Diagnosis on referral |
NO |
| BeforeAfterTime |
0-Before; 1-After. Specifies how to process Time field. IE, if BeforeAfterTime=0, then find terms from specified StartDate, but only BEFORE specified Time. |
NO |
| Time |
Time used for filtering the result. Used to filter terms before or after specific time of the day |
NO |
GetPrereservationForProcedureResponseCOS
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="Prereservation">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="HOSIdentifier" type="xs:string" />
<xs:element minOccurs="1" maxOccurs="1" name="UrgencyType" type="UrgencyTypeForAppType" />
<xs:element minOccurs="1" maxOccurs="1" name="DateTime" type="xs:dateTime"/>
<xs:element minOccurs="1" maxOccurs="1" name="Name" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="Description" type="xs:string" />
<xs:element minOccurs="1" maxOccurs="1" name="ResponseCode" type="ResponseCodeType" />
</xs:all>
</xs:complexType>
</xs:element>
<xs:element name="PrereservationsList">
<xs:complexType>
<xs:sequence>
<xs:element ref="Prereservation" minOccurs="0" maxOccurs="unbounded" />
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="GetPrereservationsForProcedureResponseCOS" nillable="true">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="1" maxOccurs="1" name="SuccessStatus" type="SuccessStatusType" />
<xs:element minOccurs="0" maxOccurs="1" name="ErrorList" type="ErrorListType" />
<xs:element minOccurs="0" maxOccurs="unbounded" ref="PrereservationsList" />
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<GetPrereservationsForProcedureResponseCOS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SuccessStatus>1</SuccessStatus>
<PrereservationsList>
<Prereservation>
<HOSIdentifier>1234567890123456789</HOSIdentifier>
<UrgencyType>2</UrgencyType>
<DateTime>2019-12-31T12:00:00</DateTime>
<Name>Name</Name>
<Description>Description1</Description>
<ResponseCode>01</ResponseCode>
</Prereservation>
<Prereservation>
<HOSIdentifier>1234567890123456789</HOSIdentifier>
<UrgencyType>2</UrgencyType>
<DateTime>2019-12-31T12:00:00</DateTime>
<Name>Name</Name>
<Description>Description2</Description>
<ResponseCode>01</ResponseCode>
</Prereservation>
</PrereservationsList>
</GetPrereservationsForProcedureResponseCOS>
Element Descriptions:
Common:
| Element name |
Element description |
Mandatory / Condition |
| SuccessStatus |
References catalogue SuccessStatus |
YES |
| ErrorList |
List of errors |
If SuccessStatus is set to Fail |
| PrereservationsList |
Prereservation list |
If SuccessStatus is set to Success and if there is any prereservation available |
Prereservation details:
| Element name |
Element description |
Mandatory / Condition |
| HOSIdentifier |
Unique identifier of the reservation in the facility |
YES |
| UrgencyType |
Urgency type code (References catalogue UrgencyCodeType) |
YES |
| DateTime |
Appointment date and time |
YES |
| Name |
Medical facility name |
YES |
| Description |
Additional notes |
NO |
| ResponseCode |
References catalogue ResponseCodeType |
YES |
4.28 BookRereservationCOS
Method used to make a reservation in the facility. Internally calls BookReservationHOS. The method is used only as a proxy to HOS.
Appointment status change:
| Status before |
Status after |
| No status |
Vpisan |
Referral status change:
Onetime/Reusable/Permanent referral:
| Status before |
Condition |
Status after |
Izdana |
This is the first appointment |
Vpisana |
BookReservationRequestCOS
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="BookReservationRequestCOS">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="ApiKey" type="NonEmptyString" />
<xs:element minOccurs="1" maxOccurs="1" name="HealthcareProviderIndex" type="BPIType" />
<xs:element minOccurs="1" maxOccurs="1" name="MedicalFacilityCode" type="BPIType" />
<xs:element minOccurs="0" maxOccurs="1" name="MedicalFacilitySpecificCode" type="BPIspecificType" />
<xs:element minOccurs="1" maxOccurs="1" name="MedicalProcedureCode" type="xs:string" />
<xs:element minOccurs="1" maxOccurs="1" name="HOSIdentifier" type="xs:string" />
<xs:element minOccurs="1" maxOccurs="1" name="BookerIdentifier" type="xs:string" />
<xs:element minOccurs="1" maxOccurs="1" name="UrgencyType" type="UrgencyTypeForAppType" />
<xs:element minOccurs="1" maxOccurs="1" name="ReferralUniqueIdentifier" type="ReferralUidType" />
<xs:element minOccurs="0" maxOccurs="1" name="ReferralDiagnosis" type="ReferralDiagnosisType" />
<xs:element minOccurs="0" maxOccurs="1" name="PatientUniqueIdentifier" type="PatientUIdType" />
<xs:element minOccurs="1" maxOccurs="1" name="PatientInsuranceIdentifier" type="PatientInsIdType" />
<xs:element minOccurs="0" maxOccurs="1" name="PatientName" type="NonEmptyString" />
<xs:element minOccurs="0" maxOccurs="1" name="PatientSurname" type="NonEmptyString" />
<xs:element minOccurs="0" maxOccurs="1" name="PatientBirthDate" type="xs:dateTime" />
<xs:element minOccurs="0" maxOccurs="1" name="PatientGender" type="PatientGenderType" />
<xs:element minOccurs="0" maxOccurs="1" name="StreetName" type="NonEmptyString" />
<xs:element minOccurs="0" maxOccurs="1" name="StreetNumber" type="NonEmptyString" />
<xs:element minOccurs="0" maxOccurs="1" name="CityName" type="NonEmptyString" />
<xs:element minOccurs="0" maxOccurs="1" name="CityPostalCode" type="NonEmptyString" />
<xs:element minOccurs="0" maxOccurs="1" name="DistrictCode" type="NonEmptyString" />
<xs:element minOccurs="0" maxOccurs="1" name="PatientEMail" type="EmailType" />
<xs:element minOccurs="0" maxOccurs="1" name="PatientPhone" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="PatientMobile" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="OfficePhone" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="OfficeNotes" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="ControlExam" type="xs:boolean" />
<xs:element minOccurs="0" maxOccurs="1" name="RequestedByPatient" type="RequestedByPatientType" />
<xs:element minOccurs="0" maxOccurs="1" name="MedicallyConditioned" type="MedicallyConditionedType" />
<xs:element minOccurs="1" maxOccurs="1" name="BookedDate" type="xs:dateTime" />
<xs:element minOccurs="1" maxOccurs="1" name="ResponseCode" type="ResponseCodeType" />
<xs:element minOccurs="0" maxOccurs="1" name="WantsSpecificDoctor" type="xs:boolean" />
<xs:element minOccurs="0" maxOccurs="1" name="WasInformedOfOthers" type="xs:boolean" />
<xs:element minOccurs="0" maxOccurs="1" name="CareTeamIdentifier" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="LocationIdentifier" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="DocIdentifier" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="DeviceIdentifier" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="AppointmentEndTime" type="xs:dateTime" nillable="true"/>
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<BookReservationRequestCOS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ApiKey>test</ApiKey>
<HealthcareProviderIndex>10000</HealthcareProviderIndex>
<MedicalFacilityCode>12345</MedicalFacilityCode>
<MedicalProcedureCode>1234</MedicalProcedureCode>
<HOSIdentifier>1234567890123456789</HOSIdentifier>
<BookerIdentifier>123</BookerIdentifier>
<UrgencyType>3</UrgencyType>
<ReferralUniqueIdentifier>1234567890123</ReferralUniqueIdentifier>
<ReferralDiagnosis>A20</ReferralDiagnosis>
<PatientInsuranceIdentifier>123456789</PatientInsuranceIdentifier>
<PatientName>PatientName</PatientName>
<PatientSurname>PatientSurname</PatientSurname>
<PatientBirthDate>1980-01-01T00:00:00</PatientBirthDate>
<PatientGender>1</PatientGender>
<StreetName>StreetName</StreetName>
<StreetNumber>StreetNumber</StreetNumber>
<CityName>CityName</CityName>
<CityPostalCode>CityPostalCode</CityPostalCode>
<ControlExam>false</ControlExam>
<BookedDate>2019-01-01T00:00:00</BookedDate>
<ResponseCode>01</ResponseCode>
<WantsSpecificDoctor>false</WantsSpecificDoctor>
<WasInformedOfOthers>true</WasInformedOfOthers>
<CareTeamIdentifier>12345</CareTeamIdentifier>
<LocationIdentifier>Soba1</LocationIdentifier>
<DocIdentifier>12345</DocIdentifier>
<DeviceIdentifier>12345</DeviceIdentifier>
<AppointmentEndTime>2000-01-01T00:00:00</AppointmentEndTime>
</BookReservationRequestCOS>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| ApiKey |
Application key of the application making the request |
YES |
| HealthcareProviderIndex |
Code of facility which makes the reservation (for reservations made from ReferralPublicWeb we send the BPI of IN2) |
YES |
| MedicalFacilityCode |
Medical facility code (BPI) – the facility for which the reservation is made |
YES |
| MedicalFacilitySpecificCode |
Medical facility specific code (Used when multiple software vendors maintain the IS of the same facility) |
Only if exists |
| MedicalProcedureCode |
Unique identifier of the medical procedure (VZS) |
YES |
| HOSIdentifier |
Unique identifier of the reservation in the facility |
YES |
| BookerIdentifier |
If appointment is made by doctor, doctor code is used. If appointment is created by patient via public eAppointment web portal, then Patient insurance number (ZZZS) is used |
YES |
| UrgencyType |
Urgency type code (References catalogue UrgencyCodeType) |
YES |
| ReferralUniqueIdentifier |
Referral unique identifier |
YES |
| ReferralDiagnosis |
Referral diagnosis unique identifier |
NO |
| PatientUniqueIdentifier |
Unique identifier of the patient (EMŠO) |
NO |
| PatientInsuranceIdentifier |
Insurance identifier of the patient (KZZ) |
YES |
| PatientName |
Patient first name |
NO |
| PatientSurname |
Patient last name |
NO |
| PatientBirthDate |
Patient birth date |
NO |
| PatientGender |
Patient gender (References catalogue PatientGenderType) |
NO |
| StreetName |
Street where the patient lives |
NO if DistrictCode is 000 |
| StreetNumber |
Street number where the patient lives |
NO if DistrictCode is 000 |
| CityName |
Name of the city patient lives in |
NO if DistrictCode is 000 |
| CityPostalCode |
Postal code of the city patient lives in |
NO if DistrictCode is 000 |
| DistrictCode |
Code of the district patient lives in |
NO |
| PatientEMail |
Patient email |
NO |
| PatientPhone |
Patient phone |
NO |
| PatientMobile |
Patient mobile |
NO |
| OfficePhone |
Phone of the office where the medical procedure is being performed |
NO |
| OfficeNotes |
Notes from the office where the medical procedure is being performed |
NO |
| ControlExam |
Flag indicating if the medical procedure is a control exam |
NO |
| RequestedByPatient |
References catalogue RequestedByPatientType |
NO |
| MedicallyConditioned |
References catalogue MedicallyConditionedType |
NO |
| BookedDate |
Date and time of the reservation |
YES |
| ResponseCode |
Code of the booked slot type (References catalogue ResponseCodeType) |
YES |
| WantsSpecificDoctor |
True or False. Indicates if the appointment was selected based on the doctor performing the medical procedure |
NO |
| WasInformedOfOthers |
True or False. Indicates if the patient was aware of other earlier appointments (if they existed at the time when the reservation was made). Used when selected appointment is outside of legal boundaries |
NO |
| CareTeamIdentifier |
Care team identifier |
NO |
| LocationIdentifier |
Ambulance/room where the medical procedure is being performed |
Only if medical facility uses process D |
| DocIdentifier |
Doctor identifier |
NO |
| DeviceIdentifier |
Device identifier |
NO |
| AppointmentEndTime |
Information about end time of appointment |
Only if medical facility uses process D |
BookRereservationResponseCOS
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="BookReservationResponseCOS">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="SuccessStatus" type="SuccessStatusType" />
<xs:element minOccurs="0" maxOccurs="1" name="ErrorList" type="ErrorListType"/>
<xs:element minOccurs="0" maxOccurs="1" name="AppointmentUniqueIdentifier" type="AppointmentUnqIdenType" />
<xs:element minOccurs="0" maxOccurs="1" name="HOSIdentifier" type="xs:string"/>
<xs:element minOccurs="0" maxOccurs="1" name="AdditionalNotes" type="xs:string"/>
<xs:element minOccurs="0" maxOccurs="1" name="LocationDescription" type="xs:string" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<BookReservationResponseCOS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SuccessStatus>1</SuccessStatus>
<AppointmentUniqueIdentifier>123456789012345</AppointmentUniqueIdentifier>
<HOSIdentifier>1234567890123456789</HOSIdentifier>
<AdditionalNotes>test note</AdditionalNotes>
<LocationDescription>test description</LocationDescription>
</BookReservationResponseCOS>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| SuccessStatus |
References catalogue SuccessStatus |
YES |
| AppointmentUniqueIdentifier |
Appointment unique identifier |
If SuccessStatus is set to Success |
| HOSIdentifier |
Unique identifier of the reservation in the facility |
If SuccessStatus is set to Success |
| AdditionalNotes |
Additional notes about the exam (doctor's note related to the order visible on the order confirmation) |
NO |
| LocationDescription |
Additional notes about the location where the exam is performed (i.e. “East block, second floor”) |
NO |
| ErrorList |
List of errors |
If SuccessStatus is set to Fail |
4.29 CancelReservationCOS
Method used to cancel a reservation. Regarding the status change, the same rules applies as for CancelAppointments.
It is possible to cancel only one reservation per one call. The method internally calls CancelReservationHOS.
CancelReservationRequestCOS
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:include schemaLocation="AppointmentCancellationReasonsList.xsd" />
<xs:element name="CancelReservationRequestCOS">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="ApiKey" type="NonEmptyString" />
<xs:element minOccurs="1" maxOccurs="1" name="HealthcareProviderIndex" type="BPIType" />
<xs:element minOccurs="1" maxOccurs="1" name="MedicalFacilityCode" type="BPIType" />
<xs:element minOccurs="0" maxOccurs="1" name="MedicalFacilitySpecificCode" type="BPIspecificType" />
<xs:element minOccurs="1" maxOccurs="1" name="MedicalProcedureCode" type="MedicalProcedureCodeType" />
<xs:element minOccurs="1" maxOccurs="1" name="AppointmentUniqueIdentifier" type="AppointmentUnqIdenType" />
<xs:element minOccurs="1" maxOccurs="1" name="PatientInsuranceIdentifier" type="PatientInsIdType" />
<xs:element minOccurs="1" maxOccurs="1" name="CancellationReasonCode" type="AppointmentCancellationReasonType" />
<xs:element minOccurs="0" maxOccurs="1" name="CancellationReasonDescription" type="xs:string" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<CancelReservationRequestCOS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ApiKey>1d75ed19-1499-47ce-92cf-2377d01f9ade</ApiKey>
<HealthcareProviderIndex>12681</HealthcareProviderIndex>
<MedicalFacilityCode>45451</MedicalFacilityCode>
<MedicalProcedureCode>1010P</MedicalProcedureCode>
<AppointmentUniqueIdentifier>123456789012345</AppointmentUniqueIdentifier>
<PatientInsuranceIdentifier>123456789</PatientInsuranceIdentifier>
<CancellationReasonCode>13</CancellationReasonCode>
</CancelReservationRequestCOS>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| ApiKey |
Application key of the application making the request |
YES |
| HealthcareProviderIndex |
Code (BPI) of who is cancelling the reservation |
YES |
| MedicalFacilityCode |
Medical facility code (BPI) |
YES |
| MedicalFacilitySpecificCode |
Medical facility specific code (Used when multiple software vendors maintain the IS of the same facility) |
Only if exists |
| MedicalProcedureCode |
Medical procedure unique identifier (VZS) |
YES |
| PatientInsuranceIdentifier |
Patient insurance identifier (KZZ) |
YES |
| AppointmentUniqueIdentifier |
Appointment unique identifier |
YES |
| CancellationReasonCode |
Cancellation reason code (References catalogue AppointmentCancellationReasonType) |
YES |
| CancellationReasonDescription |
Additional notes about the cancellation |
Only if cancellation reason is Ostalo |
CancelReservationResponseCOS
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="CancelReservationResponseCOS">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="SuccessStatus" type="SuccessStatusType" />
<xs:element minOccurs="0" maxOccurs="1" name="ErrorList" type="ErrorListType" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<CancelReservationResponseCOS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SuccessStatus>1</SuccessStatus>
</CancelReservationResponseCOS>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| SuccessStatus |
References catalogue SuccessStatus |
YES |
| ErrorList |
List of errors |
If SuccessStatus is set to Fail |
4.30 RegisterConcessioner
Method that has to be called by the facilities that aren’t available all the time.
With this method they notify that they are online and available so the central system can send the requests for free slot fetch, appointments fetch and cancellations/realisations fetch (processes A, B, C).
It is advised to call this method every 5 minutes while online.
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="RegisterConcessionerRequest">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="ApiKey" type="NonEmptyString" />
<xs:element minOccurs="1" maxOccurs="1" name="MedicalFacilityCode" type="BPIType" />
<xs:element minOccurs="0" maxOccurs="1" name="MedicalFacilitySpecificCode" type="BPIspecificType" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<RegisterConcessionerRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ApiKey>test</ApiKey>
<MedicalFacilityCode>10000</MedicalFacilityCode>
<MedicalFacilitySpecificCode>10000A</MedicalFacilitySpecificCode>
</RegisterConcessionerRequest>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| ApiKey |
Application key of the application making the request |
YES |
| MedicalFacilityCode |
Medical facility code (BPI) |
YES |
| MedicalFacilitySpecificCode |
Medical facility specific code (Used when multiple software vendors maintain the IS of the same facility) |
Only if exists |
RegisterConcessionerResponse
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="RegisterConcessionerResponse">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="SuccessStatus" type="SuccessStatusType" />
<xs:element minOccurs="0" maxOccurs="1" name="ErrorList" type="ErrorListType" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<RegisterConcessionerResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SuccessStatus>1</SuccessStatus>
</RegisterConcessionerResponse>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| SuccessStatus |
References catalogue SuccessStatus |
YES |
| ErrorList |
List of errors |
If SuccessStatus is set to Fail |
4.31 RegisterProceduresForConcessioner
Method that has to be called by the facilities that aren’t available all the time.
Using this method the facility send the list of procedures available at the facility.
Based on that the central system will send the requests for free slot fetch, appointments fetch and cancellations/realisations fetch (processes A, B, C).
It is advised to call this method every time after the first call of RegisterConsessioner method or once a day.
RegisterProceduresForConcessionerRequest
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="ProcedureCodes">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="1" maxOccurs="unbounded" name="string" type="MedicalProcedureCodeType" />
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="RegisterProceduresForConcessionerRequest">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="ApiKey" type="NonEmptyString" />
<xs:element minOccurs="1" maxOccurs="1" name="MedicalFacilityCode" type="BPIType" />
<xs:element minOccurs="1" maxOccurs="1" ref="ProcedureCodes" />
<xs:element minOccurs="0" maxOccurs="1" name="MedicalFacilitySpecificCode" type="BPIspecificType" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
Example xml:
<?xml version="1.0" encoding="utf-8"?>
<RegisterProceduresForConcessionerRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ApiKey>90d5bd87-5bc8-4d57-bdf0-95e152222b96</ApiKey>
<MedicalFacilityCode>12345</MedicalFacilityCode>
<ProcedureCodes>
<string>1053P</string>
<string>1011P</string>
<string>1038P</string>
</ProcedureCodes>
</RegisterProceduresForConcessionerRequest>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| ApiKey |
Application key of the application making the request |
YES |
| MedicalFacilityCode |
Medical facility code (BPI) |
YES |
| MedicalFacilitySpecificCode |
Medical facility specific code (Used when multiple software vendors maintain the IS of the same facility) |
Only if exists |
| ProcedureCodes |
List of medical procedure codes |
YES |
RegisterProceduresForConcessionerResponse
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="RegisterProceduresForConcessionerResponse">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="SuccessStatus" type="SuccessStatusType" />
<xs:element minOccurs="0" maxOccurs="1" name="ErrorList" type="ErrorListType"/>
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<RegisterProceduresForConcessionerResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SuccessStatus>1</SuccessStatus>
</RegisterProceduresForConcessionerResponse>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| SuccessStatus |
References catalogue SuccessStatus |
YES |
| ErrorList |
List of errors |
If SuccessStatus is set to Fail |
4.32 GetReferralPdf
Method used to get data for generationg referral pdf confirmation.
GetReferralPdfRequest
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="GetReferralPdfRequest">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="ApiKey" type="xs:string" />
<xs:element minOccurs="1" maxOccurs="1" name="HealthcareProviderIndex" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="HealthcareProviderSpecificIndex" type="xs:string" />
<xs:element minOccurs="1" maxOccurs="1" name="ReferralUniqueIdentifier" type="xs:string" />
<xs:element minOccurs="1" maxOccurs="1" name="PatientInsuranceIdentifier" type="xs:string" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<GetReferralPdfRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ApiKey>90d5bd87-5bc8-4d57-bdf0-95e152222b96</ApiKey>
<HealthcareProviderIndex>12345</HealthcareProviderIndex>
<ReferralUniqueIdentifier>1234567890123</ReferralUniqueIdentifier>
<PatientInsuranceIdentifier>123456789</PatientInsuranceIdentifier>
</GetReferralPdfRequest>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| ApiKey |
Application key of the application making the request |
YES |
| HealthcareProviderIndex |
Medical facility code (BPI) |
YES |
| HealthcareProviderSpecificIndex |
Medical facility specific code (Used when multiple software vendors maintain the IS of the same facility) |
Only if exists |
| ReferralUniqueIdentifier |
Referral unique identifier |
YES |
| PatientInsuranceIdentifier |
Patient insurance identifier (KZZ) |
YES |
GetReferralPdfResponse
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="GetReferralPdfResponse">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="SuccessStatus" type="SuccessStatusType" />
<xs:element minOccurs="0" maxOccurs="1" name="ErrorList" type="ErrorListType" />
<xs:element minOccurs="1" maxOccurs="1" name="ReferralUniqueIdentifier" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="Referral" type="xs:base64Binary" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
Example successful response xml:
<?xml version="1.0" encoding="utf-8"?>
<GetReferralPdfResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SuccessStatus>1</SuccessStatus>
<ReferralUniquIdentifier>1234567890123</ReferralUniquIdentifier>
<Referral>JVBERi0xLjQNCiW0tba3DQoxIDAgb2JqDQo8PA0KL1BhZ2VzIDIgMCBSDQovUGFnZUxheW91dCAvT25lQ29sdW1uDQovVHlwZSAvQ2F0YWxvZw0KL091dHB1dEludGVudHMgWzw8DQovT3V0cHV0Q29uZGl0aW9uICgpDQovT3V0cHV0Q29uZGl0aW9uSWRlbnRpZmllciAoQ3VzdG9tKQ0KL1JlZ2lzdHJ5TmFtZSAoKQ0KL0luZm8gKHNSR0IgSUVDfX3TYgMDAwMDAgbg0KMDAwMDAxMDY5MSAwMDAwMCBuDQowMDAwMDA3MTIwIDAwMDAwIG4NCjAwMDAwMTIyNDIgMDAwMDAgbg0KMDAwMDAxMjc2MiAwMDAwMCBuDQowMDAwMDEzOTcxIDAwMDAwIG4NCjAwMDAwMTQyOTAgMDAwMDAgbg0KMDAwMDAxNDYxOCAwMDAwMCBuDQowMDAwMDQ1OTk1IDAwMDAwIG4NCnRyYWlsZXINCjw8DQovSW5mbyAxMyAwIFINCi9Sb290IDEgMCBSDQovU2l6ZSAyNg0KPj4NCg0Kc3RhcnR4cmVmDQo2OTA5MA0KJSVFT0YNCg== . . . </Referral>
</GetReferralPdfResponse>
Example not successful response xml:
<?xml version="1.0" encoding="utf-8"?>
<GetReferralPdfResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SuccessStatus>2</SuccessStatus>
<ErrorList>
<Error>
<Code>0002</Code>
<Description>test1</Description>
</Error>
<Error>
<Code>2</Code>
<Description>test2</Description>
</Error>
</ErrorList>attach
<ReferralUniquIdentifier>1234567890123</ReferralUniquIdentifier>
</GetReferralPdfResponse>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| SuccessStatus |
References catalogue SuccessStatus |
YES |
| ErrorList |
List of errors |
If SuccessStatus is set to Fail |
| ReferralUniqueIdentifier |
Referral unique identifier |
YES |
| Referral |
Binary content of the attachment |
If SuccessStatus is set to Success |
4.33 SubmitCrossborderSlot
This method is used for SLO hospitals to send to COS available crossborder reserved slot for active crossborder medical facilities and medical procedures.
Method returns information if the reserved slots was successfully created in the system or not, and if not, reason why creation failed.
This method is mandatory only for medical facilities which are included in pilot project Crossborder eOrdering.
SubmitCrossborderSlotRequest
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:simpleType name="SlotStatusType">
<xs:restriction base="xs:string">
<xs:enumeration value="1"/>
<xs:enumeration value="2"/>
<xs:enumeration value="3"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="StateType">
<xs:restriction base="xs:string">
<xs:enumeration value="AT"/>
<xs:enumeration value="BA"/>
<xs:enumeration value="DE"/>
<xs:enumeration value="HR"/>
<xs:enumeration value="HU"/>
<xs:enumeration value="IT"/>
<xs:enumeration value="MK"/>
<xs:enumeration value="RS"/>
<xs:enumeration value="CH"/>
<xs:enumeration value="XK"/>
</xs:restriction>
</xs:simpleType>
<xs:element name="MedicalProcedures">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="1" maxOccurs="unbounded" name="string" type="MedicalProcedureCodeType" />
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="SubmitCrossborderSlotRequest">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="ApiKey" type="NonEmptyString" />
<xs:element minOccurs="1" maxOccurs="1" name="HealthcareProviderIndex" type="BPIType" />
<xs:element minOccurs="0" maxOccurs="1" name="HealthcareProviderSpecificIndex" type="BPIspecificType" />
<xs:element minOccurs="1" maxOccurs="1" name="AppointmentUniqueIdentifier" type="AppointmentUnqIdenType" />
<xs:element minOccurs="1" maxOccurs="1" name="AppointmentDate" type="xs:dateTime" />
<xs:element minOccurs="1" maxOccurs="1" ref="MedicalProcedures" />
<xs:element minOccurs="0" maxOccurs="1" name="StateFor" type="StateType" />
<xs:element minOccurs="1" maxOccurs="1" name="AppointmentResourceName" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="AppointmentResourceDescription" type="xs:string" />
<xs:element minOccurs="1" maxOccurs="1" name="SlotStatus" type="SlotStatusType" />
<xs:element minOccurs="0" maxOccurs="1" name="AdditionalNotes" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="LocationDescription" type="xs:string" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="UTF-8"?>
<SubmitCrossborderSlotRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ApiKey>ApiKey1</ApiKey>
<HealthcareProviderIndex>12681</HealthcareProviderIndex>
<HealthcareProviderSpecificIndex>12686A</HealthcareProviderSpecificIndex>
<AppointmentUniqueIdentifier>555666777888999</AppointmentUniqueIdentifier>
<AppointmentDate>2020-10-30T09:00:00</AppointmentDate>
<MedicalProcedures>
<string>1010A</string>
<string>1010P</string>
</MedicalProcedures>
<StateFor>IT</StateFor>
<AppointmentResourceName>room No, dr. Franco</AppointmentResourceName>
<AppointmentResourceDescription>Specialist for sport injury</AppointmentResourceDescription>
<SlotStatus>1</SlotStatus>
<AdditionalNotes>bring medical documentation</AdditionalNotes>
<LocationDescription>green building, 1st floor, room 123</LocationDescription>
</SubmitCrossborderSlotRequest>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| ApiKey |
Application key of the application making the request |
YES |
| HealthcareProviderIndex |
Medical facility code (BPI) |
YES |
| HealthcareProviderSpecificIndex |
Medical facility specific code (Used when multiple software vendors maintain the IS of the same facility) |
Only if exists |
| AppointmentUniqueIdentifier |
Appointment unique identifier |
YES |
| AppointmentDate |
Appointment date and time |
YES |
| MedicalProcedures |
List of medical procedure codes |
YES |
| StateFor |
Code of Crossborder State (Slots will be available only to defined crossborder state). Value: If null or empty slot will be available to any state. Country code is ISO alpha-2 (two letters) format, possible values: AT Austria, BA Bosnia and Herzegovina, HR Croatia, DE Germany, HU Hungary, IT Italy, MK Macedonia, RS Serbia, CH Switzerland, XK Kosovo |
NO |
| AppointmentResourceName |
Name of appointment resource (i.e. “room No, dr. Franco…”) |
YES |
| AppointmentResourceDescription |
Description of appointment resource (i.e. “Specialist for sport injury…”) |
NO |
| SlotStatus |
Flag indicating the status of reserved slot - 1 = Active, 2 = Canceled, 3 = Update. Slot can be Canceled and Updated only if slot exists and is Active (not already booked). Slot status Update will update only fields: AppointmentDate, AppointmentResourceName and AppointmentResourceDescription |
YES |
| AdditionalNotes |
Additional notes for patient specific for procedure (i.e. “Please bring all documentation”) |
NO |
| LocationDescription |
Description of location where procedure can be made (i.e. “East block, second floor”) |
NO |
SubmitCrossborderSlotResponse
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name=" SubmitCrossborderSlotResponse ">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="SuccessStatus" type="SuccessStatusType" />
<xs:element minOccurs="0" maxOccurs="1" name="ErrorList" type="ErrorListType" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<RegisterProceduresForConcessionerResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SuccessStatus>1</SuccessStatus>
</RegisterProceduresForConcessionerResponse>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| SuccessStatus |
References catalogue SuccessStatus |
YES |
| ErrorList |
List of errors |
If SuccessStatus is set to Fail |
4.43 GetReferralTimeline
Method used to get timeline about one referral.
GetReferralTimelineRequest
XSD Schema:
<?xml version=“1.0“ encoding=“utf-8“?>
<xs:schema xmlns:xs=“http://www.w3.org/2001/XMLSchema“>
<xs:include schemaLocation=“Common.xsd“ />
<xs:element name=“GetReferralTimelineRequest“>
<xs:complexType>
<xs:all>
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“ApiKey“ type=“NonEmptyString“ />
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“HealthcareProviderIndex“ type=“BPIType“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“HealthcareProviderSpecificIndex“ type=“BPIspecificType“ />
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“ReferralUniqueIdentifier“ type=“ReferralUidType“ />
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“PatientInsuranceIdentifier“ type=“PatientInsIdType“ />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version=“1.0“ encoding=“utf-8“?>
<GetReferralTimelineRequest xmlns:xsi=“http://www.w3.org/2001/XMLSchema-instance“ xmlns:xsd=“http://www.w3.org/2001/XMLSchema“>
<ApiKey>1d75ed19-1499-47ce-92cf-2377d01f9ade</ApiKey>
<HealthcareProviderIndex>12681</HealthcareProviderIndex>
<ReferralUniqueIdentifier>2014013100001</ReferralUniqueIdentifier>
<PatientInsuranceIdentifier>123456789</PatientInsuranceIdentifier>
</GetReferralTimelineRequest>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| ApiKey |
Application key of the application making the request |
YES |
| HealthcareProviderIndex |
Medical facility code (BPI) |
YES |
| HealthcareProviderSpecificIndex |
Medical facility specific code (Used when multiple software vendors maintain the IS of the same facility) |
Only if exists |
| ReferralUniqueIdentifier |
Referral unique identifier |
YES |
| PatientInsuranceIdentifier |
Patient insurance identifier (KZZ) |
YES |
GetReferralTimelineResponse
XSD Schema:
<?xml version=“1.0“ encoding=“utf-8“?>
<xs:schema xmlns:xs=“http://www.w3.org/2001/XMLSchema“>
<xs:include schemaLocation=“Common.xsd“ />
<xs:element name=“GetReferralTimelineResponse“>
<xs:complexType>
<xs:all>
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“SuccessStatus“ type=“SuccessStatusType“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“ErrorList“ type=“ErrorListType“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“ReferralUniqueIdentifier“ type=“ReferralUidType“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“ReferralTimeline“ type=“xs:string“ />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version=“1.0“ encoding=“utf-8“?>
<GetReferralTimelineResponse xmlns:xsi=“http://www.w3.org/2001/XMLSchema-instance“ xmlns:xsd=“http://www.w3.org/2001/XMLSchema“>
<SuccessStatus>1</SuccessStatus>
<ReferralUniqueIdentifier>2014013100001</ReferralUniqueIdentifier>
<ReferralTimeline>Napotnica 2014013100001 je enkratna
Izdana 20. 05. 2020 15:24:51
20. 05. 2020 16:39:00 narejeno naročilo v BOLNIŠNICA za 25. 05. 2020 11:50:00 IDT 738467216643424
25. 05. 2020 13:39:59 odpovedano naročilo IDT 738467216643424 z razlogom: Ostalo
Napotnica je v statusu Izdana</ReferralTimeline>
</GetReferralTimelineResponse>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| SuccessStatus |
References catalogue SuccessStatus |
YES |
| ErrorList |
List of errors |
If SuccessStatus is set to Fail |
| ReferralUniqueIdentifier |
Referral unique identifier |
Only if exists |
| ReferralTimeline |
Referral timeline |
Only if exists |
4.35 GetAppointmentPDF
Method used to get data for generating appointment pdf confirmation.
Method returns response with byte array which contains appointment data if the response is successful.
When request fails, reason why it failed is returned.
GetAppointmentPdfRequest
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="GetAppointmentPdfRequest">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="ApiKey" type="NonEmptyString" />
<xs:element minOccurs="1" maxOccurs="1" name="AppointmentUniqueIdentifier" type=" AppointmentUnqIdenType" />
<xs:element minOccurs="1" maxOccurs="1" name="PageSize" type="PageSizeType" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<GetAppointmentPdfRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ApiKey>test</ApiKey>
<AppointmentUniqueIdentifier>123456789123456</AppointmentUniqueIdentifier>
<PageSize>A4</PageSize>
</GetAppointmentPdfRequest>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| ApiKey |
Application key of the application making the request |
YES |
| AppointmentUniqueIdentifier |
Appointment unique identifier |
YES |
| PageSize |
Document page size type (References catalogue PageSizeType) |
YES |
GetAppointmentPdfResponse
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="GetAppointmentPdfResponse">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="SuccessStatus" type="SuccessStatusType" />
<xs:element minOccurs="0" maxOccurs="1" name="ErrorList" type="ErrorListType" />
<xs:element minOccurs="0" maxOccurs="1" name="AppointmentUniqueIdentifier" type="AppointmentUnqIdenType" />
<xs:element minOccurs="0" maxOccurs="1" name="Appointment" type="xs:base64Binary" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
Example successful response xml:
<?xml version="1.0" encoding="utf-8"?>
<GetAppointmentPdfResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SuccessStatus>1</SuccessStatus>
<AppointmentUniqueIdentifier>123456789123456</AppointmentUniqueIdentifier>
<Appointment>JVBERi0xLjQNCiW0tba3DQoxIDAgb2JqDQo8PA0KL1BhZ2VzIDIgMCBSDQovUGFnZUxheW91dCAvT25lQ29sdW1uDQovVHlwZSAvQ2F0YWxvZw0KL091dHB1dEludGVudHMgWzw8DQovT3V0cHV0Q29uZGl0aW9uICgpDQovT3V0cHV0Q29uZGl0aW9uSWRlbnRpZmllciAoQ3VzdG9tKQ0KL1JlZ2lzdHJ5TmFtZSAoKQ0KL0luZm8gKHNSR0IgSUVDfX3TYgMDAwMDAgbg0KMDAwMDAxMDY5MSAwMDAwMCBuDQowMDAwMDA3MTIwIDAwMDAwIG4NCjAwMDAwMTIyNDIgMDAwMDAgbg0KMDAwMDAxMjc2MiAwMDAwMCBuDQowMDAwMDEzOTcxIDAwMDAwIG4NCjAwMDAwMTQyOTAgMDAwMDAgbg0KMDAwMDAxNDYxOCAwMDAwMCBuDQowMDAwMDQ1OTk1IDAwMDAwIG4NCnRyYWlsZXINCjw8DQovSW5mbyAxMyAwIFINCi9Sb290IDEgMCBSDQovU2l6ZSAyNg0KPj4NCg0Kc3RhcnR4cmVmDQo2OTA5MA0KJSVFT0YNCg== . . . </Appointment>
</GetAppointmentPdfResponse>
Example not successful response xml:
<?xml version="1.0" encoding="utf-8"?>
<GetAppointmentPdfResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SuccessStatus>2</SuccessStatus>
<ErrorList>
<Error>
<Code>0002</Code>
<Description>test1</Description>
</Error>
<Error>
<Code>2</Code>
<Description>test2</Description>
</Error>
</ErrorList>
</GetAppointmentPdfResponse>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| SuccessStatus |
References catalogue SuccessStatus |
YES |
| ErrorList |
List of errors |
If SuccessStatus is set to Fail |
| AppointmentUniqueIdentifier |
Appointment unique identifier |
YES |
| Appointment |
Binary content of the attachment |
If SuccessStatus is set to Success |
4.36 GetAEUCandidates
Method used to get appointments that have expired according to the patient law, i.e. more than 35 days have passed since the appointment date, or orders that will expire in 5 days.
Orders can be both in the future and in the past i.e. that will be or should be canceled.
Method returns response with list of appointments and list of linked appointments that will be canceled because are using the same referral.
When request fails, reason why it failed is returned.
GetAEUCandidatesRequest
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="GetAEUCandidatesRequest">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="ApiKey" type="NonEmptyString" />
<xs:element minOccurs="1" maxOccurs="1" name="HealthcareProviderIndex" type="BPIType" />
<xs:element minOccurs="0" maxOccurs="1" name="HealthcareProviderSpecificIndex" type="BPIspecificType" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<GetAEUCandidatesRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ApiKey>test</ApiKey>
<HealthcareProviderIndex>12681</HealthcareProviderIndex>
<HealthcareProviderSpecificIndex>12681A</HealthcareProviderSpecificIndex>
</GetAEUCandidatesRequest>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| ApiKey |
Application key of the application making the request |
YES |
| HealthcareProviderIndex |
Medical facility code (BPI) |
YES |
| HealthcareProviderSpecificIndex |
Medical facility specific code (Used when multiple software vendors maintain the IS of the same facility) |
Only if exists |
GetAEUCandidatesResponse
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="Appointment">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="AppointmentUniqueIdentifier" type="AppointmentUnqIdenType" />
<xs:element minOccurs="1" maxOccurs="1" name="ReferralUniqueIdentifier" type="ReferralUidType" />
<xs:element minOccurs="1" maxOccurs="1" name="AppointmentExpirationDate" type="xs:dateTime" />
<xs:element minOccurs="0" maxOccurs="1" ref="LinkedAppointmentsList" />
<xs:element minOccurs="1" maxOccurs="1" name="PatientInsuranceIdentifier" type="PatientInsIdType" />
<xs:element minOccurs="0" maxOccurs="1" name="PatientUniqueIdentifier" type="PatientUIdType" />
<xs:element minOccurs="1" maxOccurs="1" name="DateConfirmed" type="xs:dateTime" />
<xs:element minOccurs="1" maxOccurs="1" name="DateCreated" type="xs:dateTime" />
<xs:element minOccurs="1" maxOccurs="1" name="MedicalProcedureCode" type="MedicalProcedureCodeType" />
</xs:all>
</xs:complexType>
</xs:element>
<xs:element name="LinkedAppointmentsList">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="1" maxOccurs="unbounded" name="AppointmentUniqueIdentifier" type="AppointmentUnqIdenType" />
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="AppointmentsList">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="1" maxOccurs="unbounded" ref="Appointment" />
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="GetAEUCandidatesResponse">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="SuccessStatus" type="SuccessStatusType" />
<xs:element minOccurs="0" maxOccurs="1" name="ErrorList" type="ErrorListType" />
<xs:element minOccurs="1" maxOccurs="1" ref="AppointmentsList" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
Example successful response xml:
<GetAEUCandidatesResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SuccessStatus>1</SuccessStatus>
<AppointmentsList>
</Appointment>
<Appointment>
<AppointmentUniqueIdentifier>111116463939525</AppointmentUniqueIdentifier>
<ReferralUniqueIdentifier>2022113000005</ReferralUniqueIdentifier>
<AppointmentExpirationDate>2023-01-04T00:00:00</AppointmentExpirationDate>
<LinkedAppointmentsList />
<PatientInsuranceIdentifier>903002024</PatientInsuranceIdentifier>
<PatientUniqueIdentifier>1507979095113</PatientUniqueIdentifier>
<DateConfirmed>2022-11-30T16:16:29</DateConfirmed>
<DateCreated>2022-11-23T16:16:48</DateCreated>
<MedicalProcedureCode>1056K</MedicalProcedureCode>
</Appointment>
<Appointment>
<AppointmentUniqueIdentifier>111112780858906</AppointmentUniqueIdentifier>
<ReferralUniqueIdentifier>2022112500002</ReferralUniqueIdentifier>
<AppointmentExpirationDate>2022-12-30T00:00:00</AppointmentExpirationDate>
<LinkedAppointmentsList>
<AppointmentUniqueIdentifier>111119380779296</ AppointmentUniqueIdentifier >
</LinkedAppointmentsList>
<PatientInsuranceIdentifier>903002024</PatientInsuranceIdentifier>
<PatientUniqueIdentifier>1507979095113</PatientUniqueIdentifier>
<DateConfirmed>2022-11-25T11:04:10</DateConfirmed>
<DateCreated>2022-11-20T11:04:17</DateCreated>
<MedicalProcedureCode>1056P</MedicalProcedureCode>
</Appointment>
<Appointment>
<AppointmentUniqueIdentifier>111115721121075</AppointmentUniqueIdentifier>
<ReferralUniqueIdentifier>2022111100016</ReferralUniqueIdentifier>
<AppointmentExpirationDate>2022-12-16T00:00:00</AppointmentExpirationDate>
<LinkedAppointmentsList>
<AppointmentUniqueIdentifier>111119116638894</AppointmentUniqueIdentifier>
<AppointmentUniqueIdentifier>111113327247341</AppointmentUniqueIdentifier>
<AppointmentUniqueIdentifier>111119555124948</AppointmentUniqueIdentifier>
</LinkedAppointmentsList>
<PatientInsuranceIdentifier>903002024</PatientInsuranceIdentifier>
<PatientUniqueIdentifier>1507979095113</PatientUniqueIdentifier>
<DateConfirmed>2022-11-11T13:23:27</DateConfirmed>
<DateCreated>2022-11-11T13:24:11</DateCreated>
<MedicalProcedureCode>1055P</MedicalProcedureCode>
</Appointment>
</AppointmentsList>
</GetAEUCandidatesResponse>
Example not successful response xml:
<?xml version="1.0" encoding="utf-8"?>
<GetAEUCandidatesResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SuccessStatus>2</SuccessStatus>
<ErrorList>
<Error>
<Code>0002</Code>
<Description>test1</Description>
</Error>
<Error>
<Code>2</Code>
<Description>test2</Description>
</Error>
</ErrorList>
</GetAEUCandidatesResponse>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| SuccessStatus |
References catalogue SuccessStatus |
YES |
| ErrorList |
List of errors |
If SuccessStatus is set to Fail |
| AppointmentsList |
List of appointments |
YES |
| Appointment |
Single appointment data |
If SuccessStatus is set to Success |
| AppointmentUniqueIdentifier |
Appointment unique identifier |
YES |
| ReferralUniqueIdentifier |
Referral unique identifier |
YES |
| AppointmentExpirationDate |
Expiration date of appointment |
YES |
| LinkedAppointmentsList |
List of appointments on the same referral that will be cancelled with expired appointment |
Only if exists |
| PatientInsuranceIdentifier |
Patient insurance identifier (KZZ) |
YES |
| PatientUniqueIdentifier |
Patient unique identifier (EMŠO) |
Only if exists |
| DateConfirmed |
Date of appointment confirmation |
YES |
| DateCreated |
Date of appointment creation |
YES |
| MedicalProcedureCode |
Medical procedure code |
YES |
4.37 GetAppointmentsForReordering
Method used to get appointments that are candidates for reordering through which the institutions will be able to accept the already calculated values of the coefficients of candidates for reordering from the central system according to the VZS.
There is also an option to accept the coefficient for an individual order (IDT). The central system will calculate the coefficient based on the open orders received in process B and through the processes of the transaction system.
If the order is accepted via both channels, and has different date information in the transaction database and in data process B, the data from process B will be taken into account.
GetAppointmentsForReorderingRequest
XSD Schema:
<?xml version=“1.0“ encoding=“utf-8“?>
<xs:schema xmlns:xs=“http://www.w3.org/2001/XMLSchema“>
<xs:include schemaLocation=“Common.xsd“ />
<xs:element name=“ GetAppointmentsForReorderingRequest “>
<xs:complexType>
<xs:all>
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“ApiKey“ type=“NonEmptyString“ />
<xs:element minOccurs=“1“ maxOccurs=“1“ name=“HealthcareProviderIndex“ type=“BPIType“ />
<xs:element minOccurs=“0“ maxOccurs=“1“ name=“HealthcareProviderSpecificIndex“ type=“BPIspecificType“ />
<xs:element minOccurs="1" maxOccurs="1" name="MedicalProcedureCode" type="MedicalProcedureCodeType" />
<xs:element minOccurs="0" maxOccurs="1" name="AppointmentUniqueIdentifier" type="AppointmentUnqIdenType" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<GetAppointmentsForReorderingRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ApiKey>test</ApiKey>
<HealthcareProviderIndex>12681</HealthcareProviderIndex>
<HealthcareProviderSpecificIndex>12681P</HealthcareProviderSpecificIndex>
<MedicalProcedureCode>1053P</MedicalProcedureCode> <AppointmentUniqueIdentifier>126816789123456</AppointmentUniqueIdentifier>
</GetAppointmentsForReorderingRequest>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| ApiKey |
Application key of the application making the request |
YES |
| HealthcareProviderIndex |
Medical facility code (BPI) |
YES |
| HealthcareProviderSpecificIndex |
Medical facility specific code (Used when multiple software vendors maintain the IS of the same facility) |
Only if exists |
| MedicalProcedureCode |
Unique identifier of the medical procedure (VZS) |
YES |
| AppointmentUniqueIdentifier |
Appointment unique identifier |
NO |
GetAppointmentsForReorderingResponse
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="ReorderingAppointments">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="ReorderingAppointmentInfo" />
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="ReorderingAppointmentInfo">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="AppointmentUniqueIdentifier" type="AppointmentUnqIdenType" />
<xs:element minOccurs="1" maxOccurs="1" name="EntryDate" type="xs:dateTime" />
<xs:element minOccurs="1" maxOccurs="1" name="AppointmentDate" type="xs:dateTime" />
<xs:element minOccurs="0" maxOccurs="1" name="PatientInsuranceIdentifier" type="PatientInsIdType" />
<xs:element minOccurs="1" maxOccurs="1" name="ReorderingCoefficient" type="xs:double" />
<xs:element minOccurs="0" maxOccurs="1" name="ReferralUniqueIdentifier" type="ReferralUidType" />
</xs:all>
</xs:complexType>
</xs:element>
<xs:element name="GetAppointmentsForReorderingResponse">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="SuccessStatus" type="SuccessStatusType" />
<xs:element minOccurs="0" maxOccurs="1" name="ErrorList" type="ErrorListType"/>
<xs:element minOccurs="0" maxOccurs="1" ref="ReorderingAppointments"/>
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<GetAppointmentsForReorderingResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SuccessStatus>1</SuccessStatus>
<ReorderingAppointments>
<ReorderingAppointmentInfo>
<AppointmentUniqueIdentifier>121212545400036</AppointmentUniqueIdentifier>
<EntryDate>0201-10-30T09:00:00</EntryDate>
<AppointmentDate>2013-11-30T09:00:00</AppointmentDate>
<PatientInsuranceIdentifier>256985412</PatientInsuranceIdentifier>
<ReorderingCoefficient>26.12</ReorderingCoefficient>
<ReferralUniqueIdentifier>2024051600002</ReferralUniqueIdentifier>
</ReorderingAppointmentInfo>
<ReorderingAppointmentInfo>
<AppointmentUniqueIdentifier>151515151555555</AppointmentUniqueIdentifier>
<EntryDate>0201-10-30T09:00:00</EntryDate>
<AppointmentDate>2013-11-30T09:00:00</AppointmentDate>
<PatientInsuranceIdentifier>123659487</PatientInsuranceIdentifier>
<ReorderingCoefficient>13.56</ReorderingCoefficient>
<ReferralUniqueIdentifier>2024051600003</ReferralUniqueIdentifier>
</ReorderingAppointmentInfo>
</ReorderingAppointments>
</GetAppointmentsForReorderingResponse>
Element Descriptions:
Common:
| Element name |
Element description |
Mandatory |
| ReorderingAppointments |
Appointments list |
If SuccessStatus is set to Success and if there are any appointments |
| SuccessStatus |
References catalogue SuccessStatus |
YES |
| ErrorList |
List of errors |
If SuccessStatus is set to Fail |
Appointment details:
| Element name |
Element description |
Mandatory |
| AppointmentUniqueIdentifier |
Appointment unique identifier |
YES |
| EntryDate |
Date when appointment was created |
YES |
| AppointmentDate |
Appointment date and time |
YES |
| PatientInsuranceIdentifier |
Insurance identifier of the patient (KZZ) |
NO |
| ReorderingCoefficient |
Coefficient used to prioritize patients for reordering |
YES |
| ReferralUniqueIdentifier |
Referral unique identifier |
NO |
4.38 ReferralTerminationWarning
Method is used to receive a warning information about termination of referral via methods that terminate the activity of referral with flag Control Not Needed (e.g. : AppointmentRealisation, ReferralTermination).
The central system returns three consolidating warning information.
One information is about which referral is being terminated.
Second is about which active left appointments are going to be cancelled accordingly.
And finally, third information gives an input about the cascade referrals made on behalf of the one being terminated.
Their current statuses aren’t going to be modified. These three information are meant to be shown when flag Control Not Neeeded is picked on interface.
According to element Action information in request, it is determined whether the warning message is intended for AppointmentRealisation or ReferralTermination.
ReferralTerminationWarningRequest
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="ReferralTerminationWarningRequest">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="ApiKey" type="NonEmptyString" />
<xs:element minOccurs="1" maxOccurs="1" name="HealthcareProviderIndex" type="BPIType" />
<xs:element minOccurs="1" maxOccurs="1" name="ReferralUniqueIdentifier" type="ReferralUidType" />
<xs:element minOccurs="0" maxOccurs="1" name="AppointmentUniqueIdentifier" type="AppointmentUnqIdenType" />
<xs:element minOccurs="0" maxOccurs="1" name="HealthcareProviderSpecificIndex" type="BPIspecificType" />
<xs:element minOccurs="1" maxOccurs="1" name="Action" type="TerminationActionType" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<ReferralTerminationWarningRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ApiKey>test</ApiKey>
<HealthcareProviderIndex>12681</HealthcareProviderIndex>
<HealthcareProviderSpecificIndex>12681P</HealthcareProviderSpecificIndex>
<ReferralUniqueIdentifier>2024051600004</ReferralUniqueIdentifier>
<Action>1</Action>
</ReferralTerminationWarningRequest>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| ApiKey |
Application key of the application making the request |
YES |
| HealthcareProviderIndex |
Medical facility code (BPI) |
YES |
| HealthcareProviderSpecificIndex |
Medical facility specific code (Used when multiple software vendors maintain the IS of the same facility) |
Only if exists |
| ReferralUniqueIdentifier |
Referral unique identifier |
YES |
| AppointmentUniqueIdentifier |
Appointment unique identifier |
NO |
| Action |
References catalogue TerminationActionType |
YES |
ReferralTerminationWarningResponse
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="ReferralTerminationWarningResponse">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="SuccessStatus" type="SuccessStatusType" />
<xs:element minOccurs="0" maxOccurs="1" name="ErrorList" type="ErrorListType" />
<xs:element minOccurs="0" maxOccurs="1" name="InfoList" type="InfoListType" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<ReferralTerminationWarningResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SuccessStatus>1</SuccessStatus>
<InfoList>
<Info>
<Description>Če nadaljujete, bo izbrana napotnica zaključena.</Description>
<ReferralUniqueIdentifier>2024051600001</ReferralUniqueIdentifier>
</Info>
<Info>
<Description>Napotnice, ki so bile izdane na osnovi izbrane napotnice, ne bodo spremenjene. </Description>
<ReferralUniqueIdentifier>2024051600002</ReferralUniqueIdentifier>
</Info>
<Info>
<Description>Če nadaljujete, bodo odpovedana preostala odprta naročila na izbrani napotnici.</Description>
<AppointmentUniqueIdentifier>126813821950299</AppointmentUniqueIdentifier>
</Info>
</InfoList>
</ReferralTerminationWarningResponse>
Element Descriptions:
Common:
| Element name |
Element description |
Mandatory |
| InfoList |
Information list |
If SuccessStatus is set to Success and if there are any info |
| SuccessStatus |
References catalogue SuccessStatus |
YES |
| ErrorList |
List of errors |
If SuccessStatus is set to Fail |
Info details:
| Element name |
Element description |
Mandatory |
| Description |
Message of information given the circumstances |
YES |
| ReferralUniqueIdentifier |
Referral unique identifier (changing according to description) |
NO |
| AppointmentUniqueIdentifier |
Appointment unique identifier (changing according to description) |
NO |
4.39 ReferralTermination
Method is used for terminating referral with flag Control Not Needed.
This method allows customer to terminate referral up to his wish and not only during the realization.
If obeyed by validation rules, result of this method concludes in successful termination of referral.
ReferralTerminationRequest
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="ReferralTerminationRequest">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="ApiKey" type="NonEmptyString" />
<xs:element minOccurs="1" maxOccurs="1" name="HealthcareProviderIndex" type="BPIType" />
<xs:element minOccurs="1" maxOccurs="1" name="ReferralUniqueIdentifier" type="ReferralUidType" />
<xs:element minOccurs="0" maxOccurs="1" name="HealthcareProviderSpecificIndex" type="BPIspecificType" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<ReferralTerminationRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<ApiKey>test</ApiKey>
<HealthcareProviderIndex>12681</HealthcareProviderIndex>
<HealthcareProviderSpecificIndex>12681P</HealthcareProviderSpecificIndex>
<ReferralUniqueIdentifier>2024051600004</ReferralUniqueIdentifier>
</ReferralTerminationRequest>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| ApiKey |
Application key of the application making the request |
YES |
| HealthcareProviderIndex |
Medical facility code (BPI) |
YES |
| HealthcareProviderSpecificIndex |
Medical facility specific code (Used when multiple software vendors maintain the IS of the same facility) |
Only if exists |
| ReferralUniqueIdentifier |
Referral unique identifier |
YES |
ReferralTerminationResponse
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="ReferralTerminationResponse">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="SuccessStatus" type="SuccessStatusType" />
<xs:element minOccurs="0" maxOccurs="1" name="ErrorList" type="ErrorListType" />
<xs:element minOccurs="0" maxOccurs="1" name="InfoList" type="InfoListType" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<ReferralTerminationResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SuccessStatus>1</SuccessStatus>
<InfoList>
<Info>
<Description>Status napotnice, ustvarjene na osnovi zaključene napotnice, ostaja nespremenjen.</Description>
<ReferralUniqueIdentifier>2024052000003</ReferralUniqueIdentifier>
</Info>
</InfoList>
</ReferralTerminationResponse>
Element Descriptions:
Common:
| Element name |
Element description |
Mandatory |
| InfoList |
Information list |
If SuccessStatus is set to Success and if there are any info |
| SuccessStatus |
References catalogue SuccessStatus |
YES |
| ErrorList |
List of errors |
If SuccessStatus is set to Fail |
Info details:
| Element name |
Element description |
Mandatory |
| Description |
Message of information given the circumstances |
YES |
| ReferralUniqueIdentifier] |
Referral unique identifier |
NO |
5. HOS web service
Hospital ordering service (HOS) methods:
1. string GetFreeSlotForProcedureHOS(int version, string openEHRRequest)
2. string GetPrereservationForProcedureHOS(int version, string openEHRRequest)
3. string BookReservationHOS(int version, string openEHRRequest)
4. string GetAppointmentsForProcedureHOS(int version, string openEHRRequest)
5. string GetRealisationsForProcedureHOS(int version, string openEHRRequest)
6. string CancelReservationHOS(int version, string openEHRRequest)
5.1 GetFreeSlotForProcedureHOS
Method used to get free slots for procedure from HOS. Method request is
called by COS and it expects response from HOS for free slots for
procedure.
GetFreeSlotForProcedureRequestHOS
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="GetFreeSlotsForProcedureRequestHOS">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="MedicalFacilityCode" type="BPIType" />
<xs:element minOccurs="0" maxOccurs="1" name="MedicalFacilitySpecificCode" type="BPIspecificType" />
<xs:element minOccurs="1" maxOccurs="1" name="MedicalProcedureCode" type="MedicalProcedureCodeType" />
<xs:element minOccurs="1" maxOccurs="1" name="SlotSize" type="xs:integer" />
<xs:element minOccurs="1" maxOccurs="1" name="SlotSizeUrgent" type="xs:integer" />
<xs:element minOccurs="1" maxOccurs="1" name="SlotSizeVeryUrgent" type="xs:integer" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<GetFreeSlotsForProcedureRequestHOS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<MedicalFacilityCode>12681</MedicalFacilityCode>
<MedicalFacilitySpecificCode>12681B</MedicalFacilitySpecificCode>
<MedicalProcedureCode>1020K</MedicalProcedureCode>
<SlotSize>4</SlotSize>
<SlotSizeUrgent>2</SlotSizeUrgent>
<SlotSizeVeryUrgent>2</SlotSizeVeryUrgent>
</GetFreeSlotsForProcedureRequestHOS>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| MedicalFacilityCode |
Medical facility code (BPI) |
YES |
| MedicalFacilitySpecificCode |
Medical facility specific code (Used when multiple software vendors maintain the IS of the same facility) |
Only if exists |
| MedicalProcedureCode |
Medical procedure unique identifier (VZS) |
YES |
| SlotSize |
Number of slots requested for regular urgency type code |
YES |
| SlotSizeUrgent |
Number of slots requested for urgent urgency type code |
YES |
| SlotSizeVeryUrgent |
Number of slots requested for very urgent urgency type code |
YES |
GetFreeSlotForProcedureResponseHOS
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="MedicalProcedureContact">
<xs:complexType>
<xs:all>
<xs:element minOccurs="0" maxOccurs="1" name="MPContactBPI" type="NonEmptyString" />
<xs:element minOccurs="0" maxOccurs="1" name="MPContactName" type="NonEmptyString" />
<xs:element minOccurs="0" maxOccurs="1" name="MPContactSurname" type="NonEmptyString" />
<xs:element minOccurs="0" maxOccurs="1" name="MPContactEmail" type="EmailType" />
<xs:element minOccurs="0" maxOccurs="1" name="MPContactTeamBPI" type="NonEmptyString" />
</xs:all>
</xs:complexType>
</xs:element>
<xs:element name="Office">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="Name" type="NonEmptyString" />
<xs:element minOccurs="0" maxOccurs="1" name="ResponseCodeRegular" type="ResponseCodeType" />
<xs:element minOccurs="0" maxOccurs="1" name="BlockSlotDateRegular" type="xs:dateTime" />
<xs:element minOccurs="0" maxOccurs="1" name="ResponseCodeUrgent" type="ResponseCodeType" />
<xs:element minOccurs="0" maxOccurs="1" name="BlockSlotDateUrgent" type="xs:dateTime" />
<xs:element minOccurs="0" maxOccurs="1" name="ResponseCodeVeryUrgent" type="ResponseCodeType" />
<xs:element minOccurs="0" maxOccurs="1" name="BlockSlotDateVeryUrgent" type="xs:dateTime" />
<xs:element minOccurs="0" maxOccurs="1" name="AdditionalNotes" type="NonEmptyString" />
<xs:element minOccurs="0" maxOccurs="1" name="CareTeamIdentifier" type="xs:string" />
</xs:all>
</xs:complexType>
</xs:element>
<xs:element name="OfficeList">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="Office" />
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="UrgencySlot">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="1" maxOccurs="1" name="Urgency" type="UrgencyTypeForAppType" />
<xs:element minOccurs="1" maxOccurs="1" name="ResponseCode" type="ResponseCodeType" />
<xs:element minOccurs="0" maxOccurs="1" name="BlockSlotSize" type="xs:integer" />
<xs:element minOccurs="0" maxOccurs="1" name="FirstSlotDate" type="xs:dateTime" />
<xs:element minOccurs="0" maxOccurs="1" name="BlockSlotDate" type="xs:dateTime" />
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="UrgencyCodeList">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="3" maxOccurs="3" ref="UrgencySlot" />
</xs:sequence>
</xs:complexType>
<xs:unique name="UrgencyUnique">
<xs:selector xpath="UrgencySlot" />
<xs:field xpath="Urgency" />
</xs:unique>
</xs:element>
<xs:element name="GetFreeSlotsForProcedureResponseHOS">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="SuccessStatus" type="SuccessStatusType" />
<xs:element minOccurs="0" maxOccurs="1" name="ErrorList" type="ErrorListType" />
<xs:element minOccurs="0" maxOccurs="1" name="MedicalFacilityCode" type="BPIType" />
<xs:element minOccurs="0" maxOccurs="1" name="MedicalFacilitySpecificCode" type="BPIspecificType" />
<xs:element minOccurs="0" maxOccurs="1" name="MedicalProcedureCode" type="MedicalProcedureCodeType" />
<xs:element minOccurs="0" maxOccurs="1" ref="UrgencyCodeList" />
<xs:element minOccurs="0" maxOccurs="1" ref="OfficeList" />
<xs:element minOccurs="0" maxOccurs="1" name="OfficeBussinessHours" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="OfficeAddress" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="OfficePostalCode" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="OfficeCity" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="OfficeWebAddress" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="OfficeEmail" type="EmailType" />
<xs:element minOccurs="0" maxOccurs="1" name="OfficePhone" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="OfficeFax" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="AdditionalNotes" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" ref="MedicalProcedureContact" />
<xs:element minOccurs="0" maxOccurs="1" name="CareTeamIdentifier" type="xs:string" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<GetFreeSlotsForProcedureResponseHOS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SuccessStatus>1</SuccessStatus>
<MedicalFacilityCode>12681</MedicalFacilityCode>
<MedicalFacilitySpecificCode>12681B</MedicalFacilitySpecificCode>
<MedicalProcedureCode>1020K</MedicalProcedureCode>
<UrgencyCodeList>
<UrgencySlot>
<Urgency>3</Urgency>
<ResponseCode>01</ResponseCode>
<BlockSlotSize>2</BlockSlotSize>
<FirstSlotDate>2019-12-12T00:00:00</FirstSlotDate>
<BlockSlotDate>2020-02-02T00:00:00</BlockSlotDate>
</UrgencySlot>
<UrgencySlot>
<Urgency>2</Urgency>
<ResponseCode>02</ResponseCode>
<BlockSlotSize>2</BlockSlotSize>
<FirstSlotDate>2019-08-13T00:00:00</FirstSlotDate>
<BlockSlotDate>2020-07-12T00:00:00</BlockSlotDate>
</UrgencySlot>
<UrgencySlot>
<Urgency>4</Urgency>
<ResponseCode>01</ResponseCode>
<BlockSlotSize>2</BlockSlotSize>
<FirstSlotDate>2019-09-07T00:00:00</FirstSlotDate>
<BlockSlotDate>2020-03-02T00:00:00</BlockSlotDate>
</UrgencySlot>
</UrgencyCodeList>
<OfficeList>
<Office>
<Name>John Malkovich</Name>
<ResponseCodeRegular>05</ResponseCodeRegular>
<BlockSlotDateRegular>2020-03-15T00:00:00</BlockSlotDateRegular>
<ResponseCodeUrgent>02</ResponseCodeUrgent>
<BlockSlotDateUrgent>2020-03-15T00:00:00</BlockSlotDateUrgent>
<ResponseCodeVeryUrgent>01</ResponseCodeVeryUrgent>
<BlockSlotDateVeryUrgent>2020-03-15T00:00:00</BlockSlotDateVeryUrgent>
<AdditionalNotes>notes</AdditionalNotes>
<CareTeamIdentifier>12346</CareTeamIdentifier>
</Office>
<Office>
<Name>John Doe</Name>
<BlockSlotDateRegular>2020-03-15T00:00:00</BlockSlotDateRegular>
</Office>
</OfficeList>
<OfficeBussinessHours>OfficeBussinessHours</OfficeBussinessHours>
<OfficeAddress>OfficeAddress</OfficeAddress>
<OfficePostalCode>OfficePostalCode</OfficePostalCode>
<OfficeCity>OfficeCity</OfficeCity>
<OfficeWebAddress>OfficeWebAddress</OfficeWebAddress>
<OfficeEmail>office.waitinglist@mail.com</OfficeEmail>
<OfficePhone>OfficePhone</OfficePhone>
<OfficeFax>OfficeFax</OfficeFax>
<AdditionalNotes>AdditionalNotes</AdditionalNotes>
<MedicalProcedureContact>
<MPContactBPI>01254</MPContactBPI>
<MPContactName>Doktor</MPContactName>
<MPContactSurname>Primarni</MPContactSurname>
<MPContactEmail>procedure.office@medical.com</MPContactEmail>
<MPContactTeamBPI>12345</MPContactTeamBPI>
</MedicalProcedureContact>
<CareTeamIdentifier>12345</CareTeamIdentifier>
</GetFreeSlotsForProcedureResponseHOS>
Element Descriptions:
Details about the person responsibile for medical procedure in facility.
| Element name |
Element description |
Mandatory |
| MPContactBPI |
BPI number of contact person |
NO |
| MPContactName |
Contact person first name |
NO |
| MPContactSurname |
Contact person last name |
NO |
| MPContactEmail |
Contact person email |
NO |
| MPContactTeamBPI |
BPI number of contact team |
NO |
Office:
Details for every doctor/ambulance (if the node is provided within the xml then name + at least one block slot date are mandatory).
| Element name |
Element description |
Mandatory |
| Name |
Doctor/resource/department name |
YES |
| ResponseCodeRegular |
Code of the booked slot type (References catalogue ResponseCodeType); if no responsecode was sent default value 01 will be used |
NO |
| BlockSlotDateRegular |
Date of the first available block slot for regular urgency type |
NO |
| ResponseCodeUrgent |
Code of the booked slot type (References catalogue ResponseCodeType); if no responsecode was sent default value 01 will be used |
NO |
| BlockSlotDateUrgent |
Date of the first available block slot for urgent urgency type |
NO |
| ResponseCodeVeryUrgent |
Code of the booked slot type (References catalogue ResponseCodeType); if no responsecode was sent default value 01 will be used |
NO |
| BlockSlotDateVeryUrgent |
Date of the first available block slot for very urgent urgency type |
NO |
| AdditionalNotes |
Additional informations about free block slot of one medical procedure (VZS) for the clinic (information about the clinic may differ from facility information). zVem web and the "Čakalne dobe" web displays this information |
NO |
| CareTeamIdentifier |
Care team identifier |
NO |
UrgencySlot:
Details for every urgency type.
| Element name |
Element description |
Mandatory |
| Urgency |
Urgency type code (References catalogue UrgencyCodeType) |
YES |
| ResponseCode |
Code of the booked slot type (References catalogue ResponseCodeType) |
YES |
| BlockSlotSize |
Number of slots requested for urgency type code |
Yes for response code 01 and 02 |
| FirstSlotDate |
Date of the first available slot |
Yes for response code 01 and 02 |
| BlockSlotDate |
Date of the first available block slot |
Yes for response code 01 and 02 |
Common:
| Element Name |
Element Description |
Mandatory |
| SuccessStatus |
References catalogue SuccessStatus |
YES |
| ErrorList |
List of errors |
If SuccessStatus is set to Fail |
| MedicalFacilityCode |
Medical facility code (BPI) |
If SuccessStatus is set to Success |
| MedicalFacilitySpecificCode |
Medical facility specific code (Used when multiple software vendors maintain the IS of the same facility) |
If SuccessStatus is set to Success and if exists |
| MedicalProcedureCode |
Medical procedure unique identifier (VZS) |
If SuccessStatus is set to Success |
| UrgencyCodeList |
Contains UrgencySlot node |
If SuccessStatus is set to Success |
| OfficeList |
Contains Office node |
NO |
| OfficeBussinessHours |
Facility business hours |
If SuccessStatus is set to Success and the facility has any available block slot |
| OfficeAddress |
Facility address |
NO |
| OfficePostalCode |
Facility postal code |
NO |
| OfficeCity |
Facility city |
NO |
| OfficeWebAddress |
Facility web address |
NO |
| OfficeEmail |
Facility email |
NO |
| OfficePhone |
Facility phone |
NO |
| OfficeFax |
Facility fax |
NO |
| AdditionalNotes |
Additional notes about the facility (zVem web and the "Čakalne dobe" web displays this information) |
NO |
| MedicalProcedureContact |
Details about the person responsible for medical procedure in facility |
NO |
| CareTeamIdentifier |
Care team identifier |
NO |
5.2 GetPrereservationForProcedureHOS
Method used to create prereservations in the HOS during the process of booking a reservation.
The method returns the current available terms in the facility based on the search input.
GetPrereservationForProcedureRequestHOS
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="GetPrereservationsForProcedureRequestHOS">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="MedicalFacilityCode" type="BPIType" />
<xs:element minOccurs="0" maxOccurs="1" name="MedicalFacilitySpecificCode" type="BPIspecificType" />
<xs:element minOccurs="1" maxOccurs="1" name="MedicalProcedureCode" type="MedicalProcedureCodeType" />
<xs:element minOccurs="0" maxOccurs="1" name="BookerIdentifier" type="BookerIdentifierType" />
<xs:element minOccurs="1" maxOccurs="1" name="ReferralUniqueIdentifier" type="ReferralUidType" />
<xs:element minOccurs="1" maxOccurs="1" name="UrgencyType" type="UrgencyTypeForAppType" />
<xs:element minOccurs="1" maxOccurs="1" name="StartDate" type="xs:dateTime" />
<xs:element minOccurs="0" maxOccurs="1" name="PatientUniqueIdentifier" type="PatientUIdType" />
<xs:element minOccurs="1" maxOccurs="1" name="PatientInsuranceIdentifier" type="PatientInsIdType" />
<xs:element minOccurs="1" maxOccurs="1" name="PatientBirthDate" type="xs:dateTime" />
<xs:element minOccurs="1" maxOccurs="1" name="PatientGender" type="PatientGenderType" />
<xs:element minOccurs="1" maxOccurs="1" name="ReferralDiagnosis" type="ReferralDiagnosisType" />
<xs:element minOccurs="0" maxOccurs="1" name="Time" type="xs:time" />
<xs:element minOccurs="0" maxOccurs="1" name="BeforeAfterTime" type="xs:boolean"/>
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<GetPrereservationsForProcedureRequestHOS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<MedicalFacilityCode>10000</MedicalFacilityCode>
<MedicalFacilitySpecificCode>10000A</MedicalFacilitySpecificCode>
<MedicalProcedureCode>1234</MedicalProcedureCode>
<BookerIdentifier>12345</BookerIdentifier>
<ReferralUniqueIdentifier>1234567890123</ReferralUniqueIdentifier>
<UrgencyType>3</UrgencyType>
<StartDate>2019-12-31T00:00:00</StartDate>
<PatientUniqueIdentifier>1234567890123</PatientUniqueIdentifier>
<PatientInsuranceIdentifier>123456789</PatientInsuranceIdentifier>
<PatientBirthDate>1990-01-10T00:00:00</PatientBirthDate>
<PatientGender>2</PatientGender>
<ReferralDiagnosis>A20</ReferralDiagnosis>
<Time>13:00:00</Time>
<BeforeAfterTime>true</BeforeAfterTime>
</GetPrereservationsForProcedureRequestHOS>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| MedicalFacilityCode |
Medical facility code (BPI) |
YES |
| MedicalFacilitySpecificCode |
Medical facility specific code (Used when multiple software vendors maintain the IS of the same facility) |
Only if exists |
| MedicalProcedureCode |
Medical procedure unique identifier (VZS) |
YES |
| BookerIdentifier |
Unique identifier (BPI) of the person which made the reservation |
NO |
| ReferralUniqueIdentifier |
Referral unique identifier |
YES |
| UrgencyType |
References catalogue UrgencyCodeType |
YES |
| StartDate |
Prereservations only after start date should be returned |
YES |
| PatientUniqueIdentifier |
Unique identifier of the patient (EMŠO) |
NO |
| PatientInsuranceIdentifier |
Insurance identifier of the patient (KZZ) |
YES |
| PatientBirthDate |
Patient date of birth |
YES |
| PatientGender |
Patient gender (References catalogue PatientGenderType) |
YES |
| ReferralDiagnosis |
Diagnosis on referral |
YES |
| Time |
Time used for filtering the result. Used to filter terms before or after specific time of the day |
NO |
| BeforeAfterTime |
0-Before; 1-After. Specifies how to process Time field. IE, if BeforeAfterTIme=0, then find terms from specified StartDate, but only BEFORE specified Time. |
NO |
GetPrereservationForProcedureResponseHOS
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="Prereservation">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="HOSIdentifier" type="xs:string" />
<xs:element minOccurs="1" maxOccurs="1" name="UrgencyType" type="UrgencyTypeForAppType" />
<xs:element minOccurs="1" maxOccurs="1" name="DateTime" type="xs:dateTime" />
<xs:element minOccurs="1" maxOccurs="1" name="Name" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="Description" type="xs:string" />
<xs:element minOccurs="1" maxOccurs="1" name="ResponseCode" type="ResponseCodeType" />
</xs:all>
</xs:complexType>
</xs:element>
<xs:element name="PrereservationsList">
<xs:complexType>
<xs:sequence>
<xs:element ref="Prereservation" minOccurs="1" maxOccurs="unbounded" />
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="GetPrereservationsForProcedureResponseHOS">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="SuccessStatus" type="SuccessStatusType" />
<xs:element minOccurs="0" maxOccurs="1" name="ErrorList" type="ErrorListType" />
<xs:element minOccurs="0" maxOccurs="1" ref="PrereservationsList" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<GetPrereservationsForProcedureResponseHOS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SuccessStatus>1</SuccessStatus>
<PrereservationsList>
<Prereservation>
<HOSIdentifier>1234567890123456789</HOSIdentifier>
<UrgencyType>2</UrgencyType>
<DateTime>2019-12-31T12:00:00</DateTime>
<Name>Name</Name>
<Description>Description1</Description>
<ResponseCode>01</ResponseCode>
</Prereservation>
<Prereservation>
<HOSIdentifier>1234567890123456789</HOSIdentifier>
<UrgencyType>2</UrgencyType>
<DateTime>2019-12-31T14:00:00</DateTime>
<Name>Name</Name>
<Description>Description2</Description>
<ResponseCode>01</ResponseCode>
</Prereservation>
</PrereservationsList>
</GetPrereservationsForProcedureResponseHOS>
Element Descriptions:
Prereservation details:
| Element name |
Element description |
Mandatory |
| HOSIdentifier |
Prereservation identifier - generated by Hospital ordering system. Must be used in BookReservation call. |
YES |
| UrgencyType |
Urgency code type (References catalogue UrgencyCodeType) |
YES |
| DateTime |
Appointment date and time |
YES |
| Name |
Medical facility name |
YES |
| Description |
Additional notes |
NO |
| ResponseCode |
References catalogue ResponseCodeType |
YES |
Common:
| Element name |
Element description |
Mandatory |
| SuccessStatus |
References catalogue SuccessStatus |
YES |
| ErrorList |
List of errors |
If SuccessStatus is set to Fail |
| PrereservationsList |
Prereservation list |
If SuccessStatus is set to Success and available |
5.3 BookReservationHOS
Method used to make a reservation in HOS.
BookReservationRequestHOS
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="BookReservationRequestHOS">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="MedicalFacilityCode" type="BPIType" />
<xs:element minOccurs="0" maxOccurs="1" name="MedicalFacilitySpecificCode" type="BPIspecificType" />
<xs:element minOccurs="0" maxOccurs="1" name="BookerIdentifier" type="BookerIdentifierType" />
<xs:element minOccurs="1" maxOccurs="1" name="PrereservationId" type="NonEmptyString" />
<xs:element minOccurs="1" maxOccurs="1" name="ReferralUniqueIdentifier" type="ReferralUidType" />
<xs:element minOccurs="1" maxOccurs="1" name="UrgencyType" type="UrgencyTypeForAppType" />
<xs:element minOccurs="0" maxOccurs="1" name="PatientUniqueIdentifier" type="PatientUIdType" />
<xs:element minOccurs="1" maxOccurs="1" name="PatientInsuranceIdentifier" type="PatientInsIdType" />
<xs:element minOccurs="0" maxOccurs="1" name="PatientName" type="NonEmptyString" />
<xs:element minOccurs="0" maxOccurs="1" name="PatientSurname" type="NonEmptyString" />
<xs:element minOccurs="0" maxOccurs="1" name="PatientBirthDate" type="xs:dateTime" />
<xs:element minOccurs="0" maxOccurs="1" name="PatientGenderType" type="PatientGenderType" />
<xs:element minOccurs="1" maxOccurs="1" name="ReferralDiagnosis" type="ReferralDiagnosisType" />
<xs:element minOccurs="0" maxOccurs="1" name="StreetName" type="NonEmptyString" />
<xs:element minOccurs="0" maxOccurs="1" name="StreetNumber" type="NonEmptyString" />
<xs:element minOccurs="0" maxOccurs="1" name="CityName" type="NonEmptyString" />
<xs:element minOccurs="0" maxOccurs="1" name="CityPostalCode" type="NonEmptyString" />
<xs:element minOccurs="0" maxOccurs="1" name="DistrictCode" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="PatientPhone" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="PatientMobile" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="PatientEmail" type="EmailType" />
<xs:element minOccurs="0" maxOccurs="1" name="OfficePhone" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="OfficeNotes" type="xs:string" />
<xs:element minOccurs="1" maxOccurs="1" name="ControlExam" type="xs:boolean" />
<xs:element minOccurs="0" maxOccurs="1" name="RequestedByPatient" type="RequestedByPatientType" />
<xs:element minOccurs="0" maxOccurs="1" name="MedicallyConditioned" type="MedicallyConditionedType" />
<xs:element minOccurs="1" maxOccurs="1" name="WantsSpecificDoctor" type="xs:boolean" />
<xs:element minOccurs="1" maxOccurs="1" name="WasInformedOfOthers" type="xs:boolean" />
<xs:element minOccurs="0" maxOccurs="1" name="CountryCode" type="CountryCodeType" />
<xs:element minOccurs="1" maxOccurs="1" name="ValidityType" type="ReferralValidityType" />
<xs:element minOccurs="0" maxOccurs="1" name="ValidityDuration" type="xs:int" />
<xs:element minOccurs="1" maxOccurs="1" name="ReferralReason" type="ReferralReasonType" />
<xs:element minOccurs="1" maxOccurs="1" name="DoctorIdentifier" type="NonEmptyString" />
<xs:element minOccurs="0" maxOccurs="1" name="DoctorGivenName" type="NonEmptyString" />
<xs:element minOccurs="0" maxOccurs="1" name="DoctorFamilyName" type="NonEmptyString" />
<xs:element minOccurs="1" maxOccurs="1" name="DoctorRole" type="DoctorType" />
<xs:element minOccurs="1" maxOccurs="1" name="OrganizationIdentifier" type="NonEmptyString" />
<xs:element minOccurs="0" maxOccurs="1" name="OrganizationName" type="NonEmptyString" />
<xs:element minOccurs="1" maxOccurs="1" name="OrganizationInPublicHealthcare" type="xs:boolean" />
<xs:element minOccurs="0" maxOccurs="1" name="OrganizationStatisticalRegion" type="StatisticalRegionCode" />
<xs:element minOccurs="1" maxOccurs="1" name="MedicalActivityFirstTypeCode" type="MedicalActivityFirstSecondTypeCode" />
<xs:element minOccurs="0" maxOccurs="1" name="MedicalActivitySecondTypeCode" type="MedicalActivityFirstSecondTypeCode" />
<xs:element minOccurs="1" maxOccurs="1" name="ScopeExamination" type="xs:boolean" />
<xs:element minOccurs="1" maxOccurs="1" name="ScopeTreatment" type="xs:boolean" />
<xs:element minOccurs="1" maxOccurs="1" name="ScopeSpecialist" type="xs:boolean" />
<xs:element minOccurs="1" maxOccurs="1" name="ReferralCreationDate" type="xs:dateTime" />
<xs:element minOccurs="0" maxOccurs="1" name="CareTeamIdentifier" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="LocationIdentifier" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="DocIdentifier" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="DeviceIdentifier" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="AppointmentEndTime" type="xs:dateTime" nillable="true"/>
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<BookReservationRequestHOS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<MedicalFacilityCode>10000</MedicalFacilityCode>
<PrereservationId>PrerId</PrereservationId>
<ReferralUniqueIdentifier>1234567891234</ReferralUniqueIdentifier>
<UrgencyType>2</UrgencyType>
<PatientUniqueIdentifier>1234567891234</PatientUniqueIdentifier>
<PatientInsuranceIdentifier>123456789</PatientInsuranceIdentifier>
<PatientName>PatientName</PatientName>
<PatientSurname>PatientSurname</PatientSurname>
<PatientBirthDate>2000-01-01T00:00:00</PatientBirthDate>
<PatientGenderType>1</PatientGenderType>
<ReferralDiagnosis>I20</ReferralDiagnosis>
<StreetName>StreetName</StreetName>
<StreetNumber>StreetNumber</StreetNumber>
<CityName>CityName</CityName>
<CityPostalCode>CityPostalCode</CityPostalCode>
<ControlExam>false</ControlExam>
<WantsSpecificDoctor>false</WantsSpecificDoctor>
<WasInformedOfOthers>false</WasInformedOfOthers>
<CountryCode>SI</CountryCode>
<ValidityType>1</ValidityType>
<ReferralReason>1</ReferralReason>
<DoctorIdentifier>DoctorIdentifier</DoctorIdentifier>
<DoctorGivenName>DoctorGivenName</DoctorGivenName>
<DoctorFamilyName>DoctorFamilyName</DoctorFamilyName>
<DoctorRole>1</DoctorRole>
<OrganizationIdentifier>OrganizationIdentifier</OrganizationIdentifier>
<OrganizationName>OrganizationName</OrganizationName>
<OrganizationInPublicHealthcare>false</OrganizationInPublicHealthcare>
<OrganizationStatisticalRegion>9</OrganizationStatisticalRegion>
<MedicalActivityFirstTypeCode>123</MedicalActivityFirstTypeCode>
<ScopeExamination>false</ScopeExamination>
<ScopeTreatment>false</ScopeTreatment>
<ScopeSpecialist>false</ScopeSpecialist>
<ReferralCreationDate>2019-01-01T00:00:00</ReferralCreationDate>
<CareTeamIdentifier>12345</CareTeamIdentifier>
<LocationIdentifier>Soba1</LocationIdentifier>
<DocIdentifier>12345</DocIdentifier>
<DeviceIdentifier>12345</DeviceIdentifier>
<AppointmentEndTime>2000-01-01T00:00:00</AppointmentEndTime>
</BookReservationRequestHOS>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| MedicalFacilityCode |
Medical facility code (BPI) |
YES |
| MedicalFacilitySpecificCode |
Medical facility specific code (Used when multiple software vendors maintain the IS of the same facility) |
Only if exists |
| BookerIdentifier |
If appointment is made by doctor, doctor code is used. If made by patient via web portal, then Patient insurance number (ZZZS) is used |
NO |
| PrereservationId |
Prereservation identifier - generated by GetPrereservationsForProcedure method Hospital ordering system |
YES |
| ReferralUniqueIdentifier |
Referral unique identifier |
YES |
| UrgencyType |
References catalogue UrgencyCodeType |
YES |
| PatientUniqueIdentifier |
Unique identifier of the patient (EMŠO) |
NO |
| PatientInsuranceIdentifier |
Insurance identifier of the patient (KZZ) |
YES |
| PatientName |
Patient first name |
YES |
| PatientSurname |
Patient last name |
YES |
| PatientBirthDate |
Patient birth date |
YES |
| PatientGenderType |
Patient gender (References catalogue PatientGenderType) |
YES |
| ReferralDiagnosis |
Referral diagnosis unique identifier |
YES |
| StreetName |
Street where the patient lives |
YES |
| StreetNumber |
Street number where the patient lives |
YES |
| CityName |
Name of the city patient lives in |
YES |
| CityPostalCode |
Postal code of the city patient lives in |
YES |
| DistrictCode |
Code of the district patient lives in |
NO |
| PatientPhone |
Patient phone |
NO |
| PatientMobile |
Patient mobile |
NO |
| PatientEmail |
Patient email |
NO |
| OfficePhone |
Office phone |
NO |
| OfficeNotes |
Notes about the office |
NO |
| ControlExam |
Flag indicating if the medical procedure is control exam |
YES |
| RequestedByPatient |
References catalogue RequestedByPatientType |
NO |
| MedicallyConditioned |
References catalogue MedicallyConditionedType |
NO |
| WantsSpecificDoctor |
True or False. Indicates if the appointment was selected based on the doctor performing the medical procedure |
YES |
| WasInformedOfOthers |
True or False. Indicates if the patient was aware of other earlier appointments (outside legal boundaries) |
YES |
| CountryCode |
Country ISO2 code |
NO |
| ValidityType |
References catalogue ReferralValidityType |
YES |
| ValidityDuration |
Duration of referral (if applicable) |
NO |
| ReferralReason |
References catalogue ReferralReasonType |
YES |
| DoctorIdentifier |
Doctor unique identifier (BPI) |
YES |
| DoctorGivenName |
Doctor first name |
YES |
| DoctorFamilyName |
Doctor last name |
YES |
| DoctorRole |
References catalogue DoctorType |
YES |
| OrganizationIdentifier |
Unique identifier of the facility (BPI) |
YES |
| OrganizationName |
Facility name |
YES |
| OrganizationInPublicHealthcare |
Flag indicating if the organization in which referral was created is in public health system |
YES |
| OrganizationStatisticalRegion |
References catalogue StatisticalRegionCode |
NO |
| MedicalActivityFirstTypeCode |
First level organization department identifier of the organization in which referral was created (VZD) |
YES |
| MedicalActivitySecondTypeCode |
Second level organization department identifier of the organization in which referral was created (VZD) |
NO |
| ScopeExamination |
Flag indicating if the referral has examination scope specified |
YES |
| ScopeTreatment |
Flag indicating if the referral has treatment scope specified |
YES |
| ScopeSpecialist |
Flag indicating if the referral has specialist scope specified |
YES |
| ReferralCreationDate |
Referral creation date and time |
YES |
| CareTeamIdentifier |
Care team identifier |
NO |
| LocationIdentifier |
Ambulance/room where the medical procedure is being performed |
Only if medical facility uses process D |
| DocIdentifier |
Doctor identifier |
NO |
| DeviceIdentifier |
Device identifier |
NO |
| AppointmentEndTime |
Information about end time of appointment |
Only if medical facility uses process D |
BookReservationResponseHOS
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="BookReservationResponseHOS">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="SuccessStatus" type="SuccessStatusType" />
<xs:element minOccurs="0" maxOccurs="1" name="ErrorList" type="ErrorListType" />
<xs:element minOccurs="0" maxOccurs="1" name="PrereservationId" type="NonEmptyString" />
<xs:element minOccurs="0" maxOccurs="1" name="AppointmentUniqueIdentifier" type="AppointmentUnqIdenType" />
<xs:element minOccurs="0" maxOccurs="1" name="AdditionalNotes" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="LocationDescription" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="OfficeAddress" type="xs:string" nillable="true"/>
<xs:element minOccurs="0" maxOccurs="1" name="MedicalActivityList" type="MedicalActivityListType" nillable="true" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<BookReservationResponseHOS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SuccessStatus>1</SuccessStatus>
<PrereservationId>PrereservationId</PrereservationId>
<AppointmentUniqueIdentifier>123456789123456</AppointmentUniqueIdentifier>
</BookReservationResponseHOS>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| SuccessStatus |
References catalogue SuccessStatus |
YES |
| ErrorList |
List of errors |
If SuccessStatus is set to Fail |
| PrereservationId |
Prereservation identifier - generated by GetPrereservationsForProcedure method Hospital ordering system |
If SuccessStatus is set to Success |
| AppointmentUniqueIdentifier |
Appointment unique identifier |
If SuccessStatus is set to Success |
| AdditionalNotes |
Additional notes for patient specific for procedure (i.e. “Please bring all documentation”) |
NO |
| LocationDescription |
Description of location where procedure can be made (i.e. “East block, second floor”) |
NO |
| OfficeAddress |
Address of location where procedure can be made |
NO |
| MedicalActivityList |
Code list of Doctor’s medical activities |
NO |
5.4 CancelReservationHOS
Method used to cancel an appointment in HOS.
CancelReservationRequestHOS
XSD Schema:
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:include schemaLocation="AppointmentCancellationReasonsList.xsd" />
<xs:element name="CancelReservationRequestHOS">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="MedicalFacilityCode" type="BPIType" />
<xs:element minOccurs="0" maxOccurs="1" name="MedicalFacilitySpecificCode" type="BPIspecificType" />
<xs:element minOccurs="1" maxOccurs="1" name="AppointmentUniqueIdentifier" type="AppointmentUnqIdenType" />
<xs:element minOccurs="0" maxOccurs="1" name="PatientInsuranceIdentifier" type="PatientInsIdType" />
<xs:element minOccurs="1" maxOccurs="1" name="CancellationReasonCode" type="AppointmentCancellationReasonType" />
<xs:element minOccurs="0" maxOccurs="1" name="CancellationReasonDescription" type="NonEmptyString" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<CancelReservationRequestHOS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<MedicalFacilityCode>10000</MedicalFacilityCode>
<MedicalFacilitySpecificCode>10000A</MedicalFacilitySpecificCode>
<AppointmentUniqueIdentifier>123456789012345</AppointmentUniqueIdentifier>
<PatientInsuranceIdentifier>123456789</PatientInsuranceIdentifier>
<CancellationReasonCode>1</CancellationReasonCode>
<CancellationReasonDescription>test1</CancellationReasonDescription>
</CancelReservationRequestHOS>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| MedicalFacilityCode |
Medical facility code (BPI) |
YES |
| MedicalFacilitySpecificCode |
Medical facility specific code (Used when multiple software vendors maintain the IS of the same facility) |
Only if exists |
| AppointmentUniqueIdentifier |
Appointment unique identifier |
YES |
| PatientInsuranceIdentifier |
Patient insurance identifier (KZZ) |
NO |
| CancellationReasonCode |
Cancellation reason code (References catalogue AppointmentCancellationReasonType |
YES |
| CancellationReasonDescription |
Additional notes about the cancellation |
Only for reason Ostalo |
CancelReservationResponseHOS
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="CancelReservationResponseHOS">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="SuccessStatus" type="SuccessStatusType" />
<xs:element minOccurs="0" maxOccurs="1" name="ErrorList" type="ErrorListType" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<CancelReservationResponseHOS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SuccessStatus>1</SuccessStatus>
</CancelReservationResponseHOS>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| SuccessStatus |
References catalogue SuccessStatus |
YES |
| ErrorList |
List of errors |
If SuccessStatus is Fail |
5.5 LinkAppointmentsToNewReferralHOS
Method used in situations when an appointment was created for a date that is after the validity of the referral. After a new referral is created for that appointment the central system will call this method on HOS so that the facility can modify the referral details on the appointment.
15 days before the expiration of a referral, if there are appointments made for a date after the referral expiration, the central system will notify the primary doctor that a new referral must be issued. When the new referral is created the facility will be informed by calling this method.
LinkAppointmentsToNewReferralRequestHOS
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="AppointmentUniqueIdentifierList">
<xs:complexType >
<xs:sequence>
<xs:element minOccurs="1" maxOccurs="unbounded" name="AppointmentUniqueIdentifier" type="AppointmentUnqIdenType" />
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="LinkAppointmentsToNewReferralRequestHOS">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="MedicalFacilityCode" type="BPIType" />
<xs:element minOccurs="0" maxOccurs="1" name="MedicalFacilitySpecificCode" type="BPIspecificType" />
<xs:element minOccurs="1" maxOccurs="1" name="OldReferralUniqueIdentifier" type="ReferralUidType" />
<xs:element minOccurs="1" maxOccurs="1" name="NewReferralUniqueIdentifier" type="ReferralUidType" />
<xs:element minOccurs="1" maxOccurs="1" ref="AppointmentUniqueIdentifierList"/>
<xs:element minOccurs="1" maxOccurs="1" name="PatientInsuranceIdentifier" type="PatientInsIdType" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version=""1.0"" encoding=""utf-8""?>
<LinkAppointmentsToNewReferralRequestHOS xmlns:xsi=""http://www.w3.org/2001/XMLSchema-instance"" xmlns:xsd=""http://www.w3.org/2001/XMLSchema"">
<MedicalFacilityCode>12345</MedicalFacilityCode>
<MedicalFacilitySpecificCode>12345A</MedicalFacilitySpecificCode>
<OldReferralUniqueIdentifier>1234567891234</OldReferralUniqueIdentifier>
<NewReferralUniqueIdentifier>1234567891235</NewReferralUniqueIdentifier>
<AppointmentUniqueIdentifierList>
<AppointmentUniqueIdentifier>123456789123456</AppointmentUniqueIdentifier>
<AppointmentUniqueIdentifier>123456789123457</AppointmentUniqueIdentifier>
<AppointmentUniqueIdentifier>123456789123458</AppointmentUniqueIdentifier>
</AppointmentUniqueIdentifierList>
<PatientInsuranceIdentifier>123456789</PatientInsuranceIdentifier>
</LinkAppointmentsToNewReferralRequestHOS>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| MedicalFacilityCode |
Medical facility code (BPI) |
YES |
| MedicalFacilitySpecificCode |
Medical facility specific code (Used when multiple software vendors maintain the IS of the same facility) |
Only if exists |
| OldReferralUniqueIdentifier |
Old referral unique identifier |
YES |
| NewReferralUniqueIdentifier |
New referral unique identifier |
YES |
| AppointmentUniqueIdentifier |
Appointment unique identifier |
YES |
| PatientInsuranceIdentifier |
Patient insurance identifier (KZZ) |
YES |
LinkAppointmentsToNewReferralResponseHOS
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="LinkAppointmentsToNewReferralResponseHOS">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="SuccessStatus" type="SuccessStatusType" />
<xs:element minOccurs="0" maxOccurs="1" name="ErrorList" type="ErrorListType" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<LinkAppointmentsToNewReferralResponseHOS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SuccessStatus>1</SuccessStatus>
</LinkAppointmentsToNewReferralResponseHOS>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| SuccessStatus |
References catalogue SuccessStatus |
YES |
| ErrorList |
List of errors |
If SuccessStatus is Fail |
5.6 GetAppointmentsForProcedureHOS
Metoda kojom HOS šalje COS-u informacije o terminima pregleda. Informacije se mogu odnositi na termine u budućnosti, ali i one u prošlosti.
Također, moguće je dobiti više termina za istu uputnicu.
GetAppointmentsForProcedureRequestHOS
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="GetAppointmentsForProcedureRequestHOS">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="MedicalFacilityCode" type="BPIType" />
<xs:element minOccurs="0" maxOccurs="1" name="MedicalFacilitySpecificCode" type="BPIspecificType" nillable="true" />
<xs:element minOccurs="1" maxOccurs="1" name="MedicalProcedureCode" type="MedicalProcedureCodeType" />
<xs:element minOccurs="1" maxOccurs="1" name="FromDate" type="xs:dateTime" />
<xs:element minOccurs="0" maxOccurs="1" name="PageNumber" type="xs:integer" nillable="true"/>
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<GetAppointmentsForProcedureRequestHOS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<MedicalFacilityCode>66791</MedicalFacilityCode>
<MedicalProcedureCode>1000</MedicalProcedureCode>
<FromDate>2019-05-02T00:00:00</FromDate>
</GetAppointmentsForProcedureRequestHOS>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| MedicalFacilityCode |
Medical facility code (BPI) |
YES |
| MedicalFacilitySpecificCode |
Medical facility specific code (Used when multiple software vendors maintain the IS of the same facility) |
Only if exists |
| MedicalProcedureCode |
Medical procedure unique identifier (VZS) |
YES |
| FromDate |
From which date to get the appointments |
YES |
| PageNumber |
Number of page for which to get appointments |
Only if paging used |
GetAppointmentsForProcedureResponseHOS
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="PatientAppointments">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="PatientAppointment" />
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="PatientAppointment">
<xs:complexType>
<xs:sequence>
<xs:element ref="PatientInfo" />
<xs:element ref="AppointmentInfo" />
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="AppointmentInfo">
<xs:complexType>
<xs:all>
<xs:element minOccurs="0" maxOccurs="1" name="MedicalProcedureInternalIdentifier" type="xs:string" nillable="true" />
<xs:element minOccurs="1" maxOccurs="1" name="AppointmentTypeCode" type="AppointmentTypeCode" />
<xs:element minOccurs="1" maxOccurs="1" name="AppointmentUniqueIdentifier" type="AppointmentUnqIdenType" />
<xs:element minOccurs="0" maxOccurs="1" name="MedicalActivityFirstTypeCode" type="MedicalActivityFirstSecondTypeCode" nillable="true" />
<xs:element minOccurs="0" maxOccurs="1" name="MedicalActivitySecondTypeCode" type="MedicalActivityFirstSecondTypeCode" nillable="true" />
<xs:element minOccurs="1" maxOccurs="1" name="EntryDate" type="xs:dateTime" />
<xs:element minOccurs="1" maxOccurs="1" name="AppointmentDate" type="xs:dateTime" />
<xs:element minOccurs="1" maxOccurs="1" name="UrgencyTypeCode" type="UrgencyTypeForRefType" />
<xs:element minOccurs="0" maxOccurs="1" name="NewUrgencyTypeCode" type="UrgencyTypeForRefType" />
<xs:element minOccurs="0" maxOccurs="1" name="AppointmentBookerCode" type="AppointmentBookerCode" />
<xs:element minOccurs="0" maxOccurs="1" name="ReferralUniqueIdentifier" type="ReferralUidType"/>
<xs:element minOccurs="0" maxOccurs="1" name="PreviousReferralUniqueIdentifier" type="xs:string" nillable ="true" />
<xs:element minOccurs="1" maxOccurs="1" name="ControlExam" type="xs:boolean" />
<xs:element minOccurs="0" maxOccurs="1" name="RequestedByPatient" type="RequestedByPatientType"/>
<xs:element minOccurs="0" maxOccurs="1" name="MedicallyConditioned" type="MedicallyConditionedType" nillable="true" />
<xs:element minOccurs="1" maxOccurs="1" name="WantsSpecificDoctor" type="xs:boolean" />
<xs:element minOccurs="1" maxOccurs="1" name="WasInformedOfOthers" type="xs:boolean" />
<xs:element minOccurs="0" maxOccurs="1" name="PatientInformedDate" type="xs:dateTime" nillable="true" />
<xs:element minOccurs="0" maxOccurs="1" name="ReferralAdmissionDate" type="xs:dateTime" nillable="true" />
<xs:element minOccurs="0" maxOccurs="1" name="TriageHealthcareProviderBpi" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="TriageHealthcareProviderName" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="TriageHealthcareProviderSurname" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="TriageDate" type="xs:dateTime" />
<xs:element minOccurs="0" maxOccurs="1" name="MedicalIndicationProviderBpi" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="MedicalIndicationProviderName" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="MedicalIndicationProviderSurname" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="PatientRequestedProviderBpi" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="PatientRequestedProviderName" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="PatientRequestedProviderSurname" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="FirstAvailableDate" type="xs:dateTime" nillable="true" />
<xs:element minOccurs="0" maxOccurs="1" name="TemporaryAppointmentDate" type="xs:dateTime" nillable="true" />
<xs:element minOccurs="0" maxOccurs="1" name="AppointmentDateOld" type="xs:dateTime" />
<xs:element minOccurs="0" maxOccurs="1" name="AppointmentRescheduledReason" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="ReservationSourceTypeCode" type="ReservationSourceTypeCode" />
<xs:element minOccurs="0" maxOccurs="1" name="ReorderingReasonCode" type="ReorderingReasonTypeCode" />
<xs:element minOccurs="0" maxOccurs="1" name="ReorderingCoefficient" type="xs:double" />
<xs:element minOccurs="0" maxOccurs="1" name="CareTeamIdentifier" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="LocationIdentifier" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="DeviceIdentifier" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="DocIdentifier" type="xs:string" />
</xs:all>
</xs:complexType>
</xs:element>
<xs:element name="PatientInfo">
<xs:complexType>
<xs:all>
<xs:element minOccurs="0" maxOccurs="1" name="PatientName" type="NonEmptyString" />
<xs:element minOccurs="0" maxOccurs="1" name="PatientSurname" type="NonEmptyString" />
<xs:element minOccurs="0" maxOccurs="1" name="PatientUniqueIdentifier" type="PatientUIdType" />
<xs:element minOccurs="0" maxOccurs="1" name="PatientInsuranceIdentifier" type="PatientInsIdType" />
<xs:element minOccurs="0" maxOccurs="1" name="PatientEUCardNumber" type="PatientEUCardNumberLength"/>
<xs:element minOccurs="0" maxOccurs="1" name="PatientDocumentNumber" type="PatientDocumentNumberLength"/>
<xs:element minOccurs="1" maxOccurs="1" name="InsuranceStateCode" type="InsuranceStateCode" />
<xs:element minOccurs="1" maxOccurs="1" name="PatientBirthDate" type="xs:dateTime" />
<xs:element minOccurs="1" maxOccurs="1" name="PatientGender" type="PatientGenderType" />
<xs:element minOccurs="0" maxOccurs="1" ref="PatientAppointmentContacts" />
</xs:all>
</xs:complexType>
</xs:element>
<xs:element name="PatientAppointmentContact">
<xs:complexType>
<xs:all>
<xs:element minOccurs="0" maxOccurs="1" name="Phone" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="Mobile" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="Note" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="Email" type="EmailType" />
</xs:all>
</xs:complexType>
</xs:element>
<xs:element name="PatientAppointmentContacts">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="PatientAppointmentContact" />
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="PagingInfo" nillable="true">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="1" maxOccurs="1" name="PageNumber" type="xs:integer" />
<xs:element minOccurs="1" maxOccurs="1" name="PageSize" type="xs:integer" />
<xs:element minOccurs="1" maxOccurs="1" name="RemainingNumber" type="xs:integer" />
<xs:element minOccurs="1" maxOccurs="1" name="TotalNumber" type="xs:integer" />
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="GetAppointmentsForProcedureResponseHOS">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="SuccessStatus" type="SuccessStatusType" />
<xs:element minOccurs="0" maxOccurs="1" name="ErrorList" type="ErrorListType"/>
<xs:element minOccurs="1" maxOccurs="1" name="MedicalFacilityCode" type="BPIType" />
<xs:element minOccurs="0" maxOccurs="1" name="MedicalFacilitySpecificCode" type="BPIspecificType" nillable="true" />
<xs:element minOccurs="1" maxOccurs="1" name="MedicalProcedureCode" type="MedicalProcedureCodeType" />
<xs:element minOccurs="0" maxOccurs="1" ref="PagingInfo" />
<xs:element minOccurs="0" maxOccurs="1" ref="PatientAppointments" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<GetAppointmentsForProcedureResponseHOS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SuccessStatus>1</SuccessStatus>
<MedicalFacilityCode>12567</MedicalFacilityCode>
<MedicalFacilitySpecificCode>12567A</MedicalFacilitySpecificCode>
<MedicalProcedureCode>1000</MedicalProcedureCode>
<PagingInfo>
<PageNumber>1</PageNumber>
<PageSize>100</PageSize>
<RemainingNumber>3</RemainingNumber>
<TotalNumber>100</TotalNumber>
</PagingInfo>
<PatientAppointments>
<PatientAppointment>
<PatientInfo>
<PatientName>Ivor</PatientName>
<PatientSurname>Markoni</PatientSurname>
<PatientUniqueIdentifier>1235556784444</PatientUniqueIdentifier>
<PatientInsuranceIdentifier>256985412</PatientInsuranceIdentifier>
<PatientEUCardNumber>555EU45698523659784523695</PatientEUCardNumber>
<PatientDocumentNumber>555DOK5897458632596359854</PatientDocumentNumber>
<InsuranceStateCode>HR</InsuranceStateCode>
<PatientBirthDate>1989-10-30T00:00:00</PatientBirthDate>
<PatientGender>1</PatientGender>
<PatientAppointmentContacts>
<PatientAppointmentContact>
<Phone>123456</Phone>
<Mobile>063695856</Mobile>
<Note>Pacient sam</Note>
<Email>ivor.markoni@gmail.com</Email>
</PatientAppointmentContact>
<PatientAppointmentContact>
<Phone>123456</Phone>
<Mobile>063695856</Mobile>
<Note>Skrbnik</Note>
<Email>anica.kovac@gmail.com</Email>
</PatientAppointmentContact>
</PatientAppointmentContacts>
</PatientInfo>
<AppointmentInfo>
<MedicalProcedureInternalIdentifier>UZV koljena interni
naziv</MedicalProcedureInternalIdentifier>
<AppointmentTypeCode>ORD</AppointmentTypeCode>
<AppointmentUniqueIdentifier>151515151555555</AppointmentUniqueIdentifier>
<MedicalActivityFirstTypeCode>100</MedicalActivityFirstTypeCode>
<MedicalActivitySecondTypeCode>101</MedicalActivitySecondTypeCode>
<EntryDate>0201-10-30T09:00:00</EntryDate>
<AppointmentDate>2013-11-30T09:00:00</AppointmentDate>
<UrgencyTypeCode>2</UrgencyTypeCode>
<NewUrgencyTypeCode>2</NewUrgencyTypeCode>
<AppointmentBookerCode>12345</AppointmentBookerCode>
<ReferralUniqueIdentifier>555REF1236954</ReferralUniqueIdentifier>
<PreviousReferralUniqueIdentifier>1234567891258</PreviousReferralUniqueIdentifier>
<ControlExam>true</ControlExam>
<RequestedByPatient>1</RequestedByPatient>
<MedicallyConditioned>2</MedicallyConditioned>
<WantsSpecificDoctor>true</WantsSpecificDoctor>
<WasInformedOfOthers>false</WasInformedOfOthers>
<PatientInformedDate>2013-10-30T09:00:00</PatientInformedDate>
<ReferralAdmissionDate>2013-10-30T09:00:00</ReferralAdmissionDate>
<TriageHealthcareProviderBpi>12345</TriageHealthcareProviderBpi>
<TriageHealthcareProviderName>Celestin</TriageHealthcareProviderName>
<TriageHealthcareProviderSurname>Vodnjov</TriageHealthcareProviderSurname>
<TriageDate>2013-11-05T09:00:00</TriageDate>
<MedicalIndicationProviderBpi>58794</MedicalIndicationProviderBpi>
<MedicalIndicationProviderName>Dejana</MedicalIndicationProviderName>
<MedicalIndicationProviderSurname>Piliček</MedicalIndicationProviderSurname>
<PatientRequestedProviderBpi>58794</PatientRequestedProviderBpi>
<PatientRequestedProviderName>Dejana</PatientRequestedProviderName>
<PatientRequestedProviderSurname>Piliček</PatientRequestedProviderSurname>
<TemporaryAppointmentDate>2013-11-30T00:00:00</TemporaryAppointmentDate>
<AppointmentDateOld>2013-11-20T00:00:00</AppointmentDateOld>
<AppointmentRescheduledReason>Bolest zdravnika</AppointmentRescheduledReason>
<ReservationSourceTypeCode>1</ReservationSourceTypeCode>
<ReorderingReasonTypeCode>1</ReorderingReasonTypeCode>
<ReorderingCoefficient>1.2</ReorderingCoefficient>
<CareTeamIdentifier>12346</CareTeamIdentifier>
<LocationIdentifier>111</LocationIdentifier>
<DeviceIdentifier>123</DeviceIdentifier>
<DocIdentifier>12345</DocIdentifier>
</AppointmentInfo>
</PatientAppointment>
<PatientAppointment>
<PatientInfo>
<PatientName>Jasna</PatientName>
<PatientSurname>Grižić</PatientSurname>
<PatientUniqueIdentifier>1235556784444</PatientUniqueIdentifier>
<PatientInsuranceIdentifier>123659487</PatientInsuranceIdentifier>
<PatientEUCardNumber>555EU45698523659784523695</PatientEUCardNumber>
<PatientDocumentNumber>555DOK5897458632596359854</PatientDocumentNumber>
<InsuranceStateCode>HR</InsuranceStateCode>
<PatientBirthDate>1989-10-30T00:00:00</PatientBirthDate>
<PatientGender>1</PatientGender>
<PatientAppointmentContacts>
<PatientAppointmentContact>
<Phone>123456</Phone>
<Mobile>063695856</Mobile>
<Note>Pacient sam</Note>
<Email>ivor.markoni@gmail.com</Email>
</PatientAppointmentContact>
<PatientAppointmentContact>
<Phone>123456</Phone>
<Mobile>063695856</Mobile>
<Note>Skrbnik</Note>
<Email>anica.kovac@gmail.com</Email>
</PatientAppointmentContact>
</PatientAppointmentContacts>
</PatientInfo>
<AppointmentInfo>
<MedicalProcedureInternalIdentifier>UZV koljena interni
naziv2</MedicalProcedureInternalIdentifier>
<AppointmentTypeCode>ORD</AppointmentTypeCode>
<AppointmentUniqueIdentifier>151515151555555</AppointmentUniqueIdentifier>
<MedicalActivityFirstTypeCode>100</MedicalActivityFirstTypeCode>
<MedicalActivitySecondTypeCode>101</MedicalActivitySecondTypeCode>
<EntryDate>0201-10-30T09:00:00</EntryDate>
<AppointmentDate>2013-11-30T09:00:00</AppointmentDate>
<UrgencyTypeCode>2</UrgencyTypeCode>
<NewUrgencyTypeCode>2</NewUrgencyTypeCode>
<AppointmentBookerCode>123456789</AppointmentBookerCode>
<ReferralUniqueIdentifier>555REF5695842</ReferralUniqueIdentifier>
<PreviousReferralUniqueIdentifier>1234567891269</PreviousReferralUniqueIdentifier>
<ControlExam>true</ControlExam>
<RequestedByPatient>1</RequestedByPatient>
<MedicallyConditioned>2</MedicallyConditioned>
<WantsSpecificDoctor>true</WantsSpecificDoctor>
<WasInformedOfOthers>false</WasInformedOfOthers>
<PatientInformedDate>2013-10-30T09:00:00</PatientInformedDate>
<ReferralAdmissionDate>2013-10-30T09:00:00</ReferralAdmissionDate>
<TriageHealthcareProviderBpi>12345</TriageHealthcareProviderBpi>
<TriageHealthcareProviderName>Celestin</TriageHealthcareProviderName>
<TriageHealthcareProviderSurname>Vodnjov</TriageHealthcareProviderSurname>
<TriageDate>2013-11-05T09:00:00</TriageDate>
<MedicalIndicationProviderBpi>58794</MedicalIndicationProviderBpi>
<MedicalIndicationProviderName>Dejana</MedicalIndicationProviderName>
<MedicalIndicationProviderSurname>Piliček</MedicalIndicationProviderSurname>
<PatientRequestedProviderBpi>58794</PatientRequestedProviderBpi>
<PatientRequestedProviderName>Dejana</PatientRequestedProviderName>
<PatientRequestedProviderSurname>Piliček</PatientRequestedProviderSurname>
<TemporaryAppointmentDate>2013-11-30T00:00:00</TemporaryAppointmentDate>
<AppointmentDateOld>2013-11-20T00:00:00</AppointmentDateOld>
<AppointmentRescheduledReason>Bolest zdravnika</AppointmentRescheduledReason>
<ReservationSourceTypeCode>1</ReservationSourceTypeCode>
</AppointmentInfo>
</PatientAppointment>
</PatientAppointments>
</GetAppointmentsForProcedureResponseHOS>
Element Descriptions:
Appointment details:
| Element name |
Element description |
Mandatory |
| MedicalProcedureInternalIdentifier |
Medical procedure unique identifier (in facility) |
NO |
| AppointmentTypeCode |
References catalogue AppointmentType |
YES |
| AppointmentUniqueIdentifier |
Appointment unique identifier |
YES |
| MedicalActivityFirstTypeCode |
First level identifier of the department patient was admitted to |
NO |
| MedicalActivitySecondTypeCode |
Second level identifier of the department patient was admitted to |
NO |
| EntryDate |
Date when appointment was created |
YES |
| AppointmentDate |
Appointment date and time |
YES |
| UrgencyTypeCode |
References catalogue UrgencyCodeType |
YES |
| NewUrgencyTypeCode |
References catalogue UrgencyCodeType |
NO |
| AppointmentBookerCode |
If appointment is made by doctor, doctor code is used. If created by patient via public portal, then ZZZS is used |
NO |
| ReferralUniqueIdentifier |
Referral unique identifier |
NO |
| PreviousReferralUniqueIdentifier |
Previous referral unique identifier |
NO |
| ControlExam |
Flag indicating if the medical procedure is control exam |
YES |
| RequestedByPatient |
References catalogue RequestedByPatientType |
NO |
| MedicallyConditioned |
References catalogue MedicallyConditionedType |
NO |
| WantsSpecificDoctor |
True or False. Indicates if the appointment was selected based on the doctor performing the medical procedure |
YES |
| WasInformedOfOthers |
True or False. Indicates if the patient was aware of other earlier appointments. Used when selected appointment is outside legal boundaries |
YES |
| PatientInformedDate |
Date and time when the patient was informed that the appointment was made |
NO |
| ReferralAdmissionDate |
Date and time when the referral document or certificate of referral creation was brought to facility |
NO |
| TriageHealthcareProviderBpi |
Identifier of the person who triaged the referral before appointment creation |
NO |
| TriageHealthcareProviderName |
First name of the person who triaged the referral |
NO |
| TriageHealthcareProviderSurname |
Last name of the person who triaged the referral |
NO |
| TriageDate |
Date and time of referral triage |
NO |
| MedicalIndicationProviderBpi |
Identifier of the person who confirmed medical indication for appointment |
NO |
| MedicalIndicationProviderName |
First name of the person who confirmed medical indication |
NO |
| MedicalIndicationProviderSurname |
Last name of the person who confirmed medical indication |
NO |
| PatientRequestedProviderBpi |
Identifier of the doctor specifically requested by the patient |
NO |
| PatientRequestedProviderName |
First name of the doctor specifically requested by the patient |
NO |
| PatientRequestedProviderSurname |
Last name of the doctor specifically requested by the patient |
NO |
| FirstAvailableDate |
First available appointment date at time of booking (if selected date wasn't the first available) |
NO |
| TemporaryAppointmentDate |
Temporary appointment date (appointment type “ORD” – queue) |
NO |
| AppointmentDateOld |
Original appointment date (if date was changed) |
NO |
| AppointmentRescheduledReason |
Reason for change of appointment date |
NO |
| ReservationSourceTypeCode |
References catalogue ReservationSourceType |
NO |
| ReorderingReasonCode |
References catalogue ReorderingReasonType |
Only if reordered |
| ReorderingCoefficient |
Coefficient used to prioritize patient in reordering |
Only if reordered |
| CareTeamIdentifier |
Care team identifier |
NO |
| LocationIdentifier |
Ambulance/room where the medical procedure is being performed |
NO |
| DeviceIdentifier |
Device identifier |
NO |
| DocIdentifier |
Doctor identifier |
NO |
Patient details:
| Element name |
Element description |
Mandatory |
| PatientName |
Patient first name |
NO |
| PatientSurname |
Patient last name |
NO |
| PatientUniqueIdentifier |
Unique identifier of the patient (EMŠO) |
NO |
| PatientInsuranceIdentifier |
Insurance identifier of the patient (KZZ) |
NO |
| PatientEUCardNumber |
Number of the EU card |
NO |
| PatientDocumentNumber |
Number of personal document (passport or ID card) |
NO |
| InsuranceStateCode |
State of insurance (ISO 3166 codes) |
YES |
| PatientBirthDate |
Patient date of birth |
YES |
| PatientGender |
Patient gender (References catalogue PatientGenderType) |
YES |
| PatientAppointmentContacts |
List of patient contacts |
NO |
| Element name |
Element description |
Mandatory |
| Phone |
Phone |
NO |
| Mobile |
Mobile |
NO |
| Note |
Note |
NO |
| Email |
Email |
NO |
Paging details:
| Element name |
Element description |
Mandatory |
| PageNumber |
The number of page for which appointments were returned |
Yes if paging is used |
| PageSize |
Number of appointments sent in current page/response |
Yes if paging is used |
| RemainingNumber |
Number of appointments not yet sent to COS; if value is 0, paging is complete and all appointments are considered sent to COS |
Yes if paging is used |
| TotalNumber |
Total number of appointments for current medical procedure (sum of appointments across all pages) |
Yes if paging is used |
Common:
| Element name |
Element description |
Mandatory |
| MedicalFacilityCode |
Medical facility code (BPI) |
YES |
| MedicalFacilitySpecificCode |
Medical facility specific code (Used when multiple software vendors maintain the IS of the same facility) |
Only if exists |
| MedicalProcedureCode |
Medical procedure unique identifier (VZS) |
YES |
| PagingInfo |
Paging details |
If paging is used and SuccessStatus is Success |
| PatientAppointments |
Appointments list |
If SuccessStatus is Success and any exist |
| SuccessStatus |
References catalogue SuccessStatus |
YES |
| ErrorList |
List of errors |
If SuccessStatus is Fail |
5.7 GetRealisationsForProcedureHOS:
Method used to get realized and canceled appointments from HOS.
DateFrom is the date of the last successful communication, it’s not the date of appointment realization.
HOS should send all realisations from last successful communication.
GetRealisationsForProcedureRequestHOS
XSD Schema:
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="GetRealisationsForProcedureRequestHOS">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="MedicalFacilityCode" type="BPIType" />
<xs:element minOccurs="0" maxOccurs="1" name="MedicalFacilitySpecificCode" type="BPIspecificType" />
<xs:element minOccurs="1" maxOccurs="1" name="MedicalProcedureCode" type="MedicalProcedureCodeType" />
<xs:element minOccurs="1" maxOccurs="1" name="FromDate" type="xs:dateTime" />
<xs:element minOccurs="0" maxOccurs="1" name="PageNumber" type="xs:integer" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<GetRealisationsForProcedureRequestHOS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<MedicalFacilityCode>10000</MedicalFacilityCode>
<MedicalProcedureCode>1010P</MedicalProcedureCode>
<FromDate>2019-01-01T00:00:00</FromDate>
</GetRealisationsForProcedureRequestHOS>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| MedicalFacilityCode |
Medical facility code (BPI) |
YES |
| MedicalFacilitySpecificCode |
Medical facility specific code (Used when multiple software vendors maintain the IS of the same facility) |
Only if exists |
| MedicalProcedureCode |
Medical procedure unique identifier (VZS) |
YES |
| FromDate |
From which date to get the realizations and cancellations (last successful communication) |
YES |
| PageNumber |
Page number (used with Paging) |
Only if paging is used |
GetRealisationsForProcedureResponseHOS
XSD Schema:
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:include schemaLocation="AppointmentCancellationReasonsList.xsd" />
<xs:element name="AppointmentRealisation">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="AppointmentUniqueIdentifier" type="AppointmentUnqIdenType" />
<xs:element minOccurs="0" maxOccurs="1" name="MedicalProcedureInternalIdentifier" type="xs:string" />
<xs:element minOccurs="1" maxOccurs="1" name="PatientInsuranceIdentifier" type="PatientInsIdType" />
<xs:element minOccurs="1" maxOccurs="1" name="RealisationDatetime" type="xs:dateTime" />
<xs:element minOccurs="1" maxOccurs="1" name="RealisationDoctorIdentifier" type="xs:string" />
<xs:element minOccurs="1" maxOccurs="1" name="RealisationDoctorName" type="xs:string" />
<xs:element minOccurs="1" maxOccurs="1" name="RealisationDoctorSurname" type="xs:string" />
<xs:element minOccurs="1" maxOccurs="1" name="ReferralGroundedCode" type="ReferralGroundedType" />
<xs:element minOccurs="0" maxOccurs="1" name="UrgencyTypeCode" type="xs:string" nillable="true" />
<xs:element minOccurs="1" maxOccurs="1" name="UrgencyTypeGrounded" type="UrgencyGroundedType" />
<xs:element minOccurs="0" maxOccurs="1" name="AppointmentEntryDate" type="xs: dateTime" nillable="true" />
<xs:element minOccurs="0" maxOccurs="1" name="AppointmentDate" type="xs: dateTime" nillable="true" />
<xs:element minOccurs="0" maxOccurs="1" name="ReferralUniqueIdentifier" type="xs: string" nillable="true" />
<xs:element minOccurs="0" maxOccurs="1" name="CareTeamIdentifier" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="LocationIdentifier" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="DeviceIdentifier" type="xs:string" />
</xs:all>
</xs:complexType>
</xs:element>
<xs:element name="AppointmentCancellation">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="AppointmentUniqueIdentifier" type="AppointmentUnqIdenType" />
<xs:element minOccurs="0" maxOccurs="1" name="MedicalProcedureInternalIdentifier" type="xs:string"/>
<xs:element minOccurs="1" maxOccurs="1" name="PatientInsuranceIdentifier" type="PatientInsIdType" />
<xs:element minOccurs="1" maxOccurs="1" name="CancellationDatetime" type="xs:dateTime" />
<xs:element minOccurs="1" maxOccurs="1" name="CancellationReasonCode" type="AppointmentCancellationReasonType" />
<xs:element minOccurs="0" maxOccurs="1" name="CancellationReasonDescription" type="xs:string" nillable="true" />
<xs:element minOccurs="1" maxOccurs="1" name="CancellationSourceCode" type="CancellationSourceType" />
<xs:element minOccurs="1" maxOccurs="1" name="CancellationGroundedCode" type="CancellationGroundedType" />
<xs:element minOccurs="0" maxOccurs="1" name="AppointmentEntryDate" type="xs: dateTime" nillable="true" />
<xs:element minOccurs="0" maxOccurs="1" name="AppointmentDate" type="xs: dateTime" nillable="true" />
<xs:element minOccurs="0" maxOccurs="1" name="ReferralUniqueIdentifier" type="xs: string" nillable="true" />
<xs:element minOccurs="0" maxOccurs="1" name="CareTeamIdentifier" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="LocationIdentifier" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="DeviceIdentifier" type="xs:string" />
</xs:all>
</xs:complexType>
</xs:element>
<xs:complexType name="AppointmentRealisations">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="AppointmentRealisation" />
</xs:sequence>
</xs:complexType>
<xs:complexType name="AppointmentCancellations">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="AppointmentCancellation" />
</xs:sequence>
</xs:complexType>
<xs:element name="GetRealisationsForProcedureResponseHOS">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="SuccessStatus" type="SuccessStatusType" />
<xs:element minOccurs="0" maxOccurs="1" name="ErrorList" type="ErrorListType" />
<xs:element minOccurs="0" maxOccurs="1" name="PagingInfo">
<xs:complexType>
<xs:sequence>
<xs:element name="PageNumber" type="xs:integer" />
<xs:element name="PageSize" type="xs:integer" />
<xs:element name="RemainingNumber" type="xs:integer" />
<xs:element name="TotalNumber" type="xs:integer" />
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element minOccurs="0" maxOccurs="1" name="AppointmentRealisations" type="AppointmentRealisations" />
<xs:element minOccurs="0" maxOccurs="1" name="AppointmentCancellations" type="AppointmentCancellations" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<GetRealisationsForProcedureResponseHOS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SuccessStatus>1</SuccessStatus>
<AppointmentRealisations>
<AppointmentRealisation>
<AppointmentUniqueIdentifier>123456789123456</AppointmentUniqueIdentifier>
<MedicalProcedureInternalIdentifier>123</MedicalProcedureInternalIdentifier>
<PatientInsuranceIdentifier>123456789</PatientInsuranceIdentifier>
<RealisationDatetime>2019-01-01T00:00:00</RealisationDatetime>
<RealisationDoctorIdentifier>12345</RealisationDoctorIdentifier>
<RealisationDoctorName>Name</RealisationDoctorName>
<RealisationDoctorSurname>Surname</RealisationDoctorSurname>
<ReferralGroundedCode>1</ReferralGroundedCode>
<UrgencyTypeCode>3</UrgencyTypeCode>
<UrgencyTypeGrounded>1</UrgencyTypeGrounded>
<AppointmentEntryDate>2019-01-01T00:00:00</AppointmentEntryDate>
<AppointmentDate>2019-01-01T00:00:00</AppointmentDate>
<ReferralUniqueIdentifier>2022120703923</ ReferralUniqueIdentifier>
<CareTeamIdentifier>12346</CareTeamIdentifier>
<LocationIdentifier>111</LocationIdentifier>
<DeviceIdentifier>123</DeviceIdentifier>
</AppointmentRealisation>
</AppointmentRealisations>
<AppointmentCancellations>
<AppointmentCancellation>
<AppointmentUniqueIdentifier>123456789123456</AppointmentUniqueIdentifier>
<MedicalProcedureInternalIdentifier>123</MedicalProcedureInternalIdentifier>
<PatientInsuranceIdentifier>123456789</PatientInsuranceIdentifier>
<CancellationDatetime>2019-01-01T00:00:00</CancellationDatetime>
<CancellationReasonCode>13</CancellationReasonCode>
<CancellationReasonDescription>Description</CancellationReasonDescription>
<CancellationSourceCode>1</CancellationSourceCode>
<CancellationGroundedCode>1</CancellationGroundedCode>
<AppointmentEntryDate>2019-01-01T00:00:00</AppointmentEntryDate>
<AppointmentDate>2019-01-01T00:00:00</AppointmentDate>
<ReferralUniqueIdentifier>2022120703923</ ReferralUniqueIdentifier>
<CareTeamIdentifier>12346</CareTeamIdentifier>
<LocationIdentifier>111</LocationIdentifier>
<DeviceIdentifier>123</DeviceIdentifier>
</AppointmentCancellation>
</AppointmentCancellations>
</GetRealisationsForProcedureResponseHOS>
Element Descriptions:
Realisation records details:
| Element name |
Element description |
Mandatory |
| AppointmentUniqueIdentifier |
Appointment unique identifier |
YES |
| MedicalProcedureInternalIdentifier |
Medical procedure unique identifier in facility |
NO |
| PatientInsuranceIdentifier |
Patient insurance identifier (KZZ) |
YES |
| RealisationDatetime |
Realisation date and time |
YES |
| RealisationDoctorIdentifier |
Unique identifier (BPI) of the doctor who performed the exam |
YES |
| RealisationDoctorName |
First name of the doctor who performed the exam |
YES |
| RealisationDoctorSurname |
Last name of the doctor who performed the exam |
YES |
| ReferralGroundedCode |
Indication if the examination was grounded/justified (References catalogue ReferralGroundedType |
YES |
| UrgencyTypeCode |
Urgency type code (References catalogue UrgencyCodeType) |
NO |
| UrgencyTypeGrounded |
Indication if urgency type of appointment was grounded/justified (References catalogue UrgencyGroundedType |
YES |
| AppointmentEntryDate |
Appointment created date and time |
NO |
| AppointmentDate |
Appointment date and time |
NO |
| ReferralUniqueIdentifier |
Referral unique identifier |
NO |
| CareTeamIdentifier |
Care team identifier |
NO |
| LocationIdentifier |
Ambulance/room where the medical procedure is being performed |
NO |
| DeviceIdentifier |
Device identifier |
NO |
Cancellation records details:
| Element name |
Element description |
Mandatory |
| AppointmentUniqueIdentifier |
Appointment unique identifier |
YES |
| MedicalProcedureInternalIdentifier |
Medical procedure unique identifier in facility |
NO |
| PatientInsuranceIdentifier |
Patient insurance identifier (KZZ) |
YES |
| CancellationDatetime |
Cancellation date and time |
YES |
| CancellationReasonCode |
Cancellation reason code (References catalogue AppointmentCancellationReasonType |
YES |
| CancellationReasonDescription |
Additional notes about the cancellation (mandatory for reason Ostalo) |
NO |
| CancellationSourceCode |
References catalogue CancellationSourceType |
YES |
| CancellationGroundedCode |
References catalogue CancellationGroundedType |
YES |
| AppointmentEntryDate |
Appointment created date and time |
NO |
| AppointmentDate |
Appointment date and time |
NO |
| ReferralUniqueIdentifier |
Referral unique identifier |
NO |
| CareTeamIdentifier |
Care team identifier |
NO |
| LocationIdentifier |
Ambulance/room where the medical procedure is being performed |
NO |
| DeviceIdentifier |
Device identifier |
NO |
Common:
| Element name |
Element description |
Mandatory |
| SuccessStatus |
References catalogue SuccessStatus |
YES |
| ErrorList |
List of errors |
If SuccessStatus is set to Fail |
| PagingInfo |
Details about paging |
Only if paging is used |
| AppointmentRealisations |
Details about appointments |
If SuccessStatus is set to Success and if there are any appointments |
| AppointmentCancellations |
Details about appointments |
If SuccessStatus is set to Success and if there are any appointments |
5.8 GetProceduresForProcessHOS
Method used to get medical procedures for appointments or realisations and cancellations before fetching appointments or realisations and cancellations from HOS.
GetProceduresForProcessRequestHOS
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="GetProceduresForProcessRequestHOS">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="MedicalFacilityCode" type="BPIType" />
<xs:element minOccurs="0" maxOccurs="1" name="MedicalFacilitySpecificCode" type="BPIspecificType" nillable="true"/>
<xs:element minOccurs="1" maxOccurs="1" name="ProcessType" type="ProcessType"/>
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="UTF-8"?>
<GetProceduresForProcessRequestHOS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<MedicalFacilityCode>50011</MedicalFacilityCode>
<ProcessType>APF</ProcessType>
</GetProceduresForProcessRequestHOS>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| MedicalFacilityCode |
Medical facility code (BPI) |
YES |
| MedicalFacilitySpecificCode |
Medical facility specific code (Used when multiple software vendors maintain the IS of the same facility) |
Only if exists |
| ProcessType |
Process type that indicates which procedures are performed by institutions for a specific type of process (APF – Appointments Fetch, ARCF – Appointments Realisation Cancellations Fetch) |
YES |
GetProceduresForProcessResponseHOS
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="ProcedureCodes">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="string" type="MedicalProcedureCodeType" />
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="GetProceduresForProcessResponseHOS">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="MedicalFacilityCode" type="BPIType" />
<xs:element minOccurs="0" maxOccurs="1" name="MedicalFacilitySpecificCode" type="BPIspecificType" nillable="true"/>
<xs:element minOccurs="1" maxOccurs="1" name="ProcessType" type="ProcessType"/>
<xs:element minOccurs="1" maxOccurs="1" ref="ProcedureCodes" />
<xs:element minOccurs="1" maxOccurs="1" name="SuccessStatus" type="SuccessStatusType" />
<xs:element minOccurs="0" maxOccurs="1" name="ErrorList" type="ErrorListType"/>
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<GetProceduresForProcessResponseHOS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SuccessStatus>1</SuccessStatus>
<MedicalFacilityCode>50011</MedicalFacilityCode>
<ProcessType>APF</ProcessType>
<ProcedureCodes>
<string>1001K</string>
<string>1001P</string>
<string>1002K</string>
<string>1002P</string>
<string>1003K</string>
<string>1003P</string>
<string>1004K</string>
<string>1004P</string>
<string>1005K</string>
<string>1005P</string>
</ProcedureCodes>
</GetProceduresForProcessResponseHOS>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| MedicalFacilityCode |
Medical facility code (BPI) |
YES |
| MedicalFacilitySpecificCode |
Medical facility specific code (Used when multiple software vendors maintain the IS of the same facility) |
Only if exists |
| ProcessType |
Process type that indicates which medical procedures are performed by institutions for a specific type of process (APF – Appointments Fetch, ARCF – Appointments Realisation Cancellations Fetch) |
YES |
| ProcedureCodes |
Medical procedure codes that facility performs for specific type of process (APF/ARCF) |
YES |
Common:
| Element name |
Element description |
Mandatory |
| SuccessStatus |
References catalogue SuccessStatus |
YES |
| ErrorList |
List of errors |
If SuccessStatus is set to Fail |
5.9 Versioning
In the central ordering system (COS), each medical facility has a current version of HOS messages it is using to communicate with the central system. COS always support two versions, the newest and the previous one.
COS uses that version to initiate communication. When the HOS is ready to start communicating using the latest version of messages, it must send a specific SOAP exception to the central system as a response to a request sent by COS. Only when it receives that specific exception, COS tries to resend the message defined by the newest version.
Example: COS calls method V2, HOS sends exception, COS calls method V3
SOAP exception to be sent is has to have Error child node and in it the Number must be 1. The version number is not sent – when COS receives this SOAP exception, it interprets it as a notification that HOS is ready to switch to the next version (based on the one it is currently on).
SOAP Exception example
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<soap:Fault>
<soap:Code>
<soap:Value>soap:Sender</soap:Value>
</soap:Code>
<soap:Reason>
<soap:Text xml:lang="en"/>
</soap:Reason>
<detail>
<Error>
<ErrorMessage>Wrong version</ErrorMessage>
<ErrorNumber>1</ErrorNumber>
</Error>
</detail>
</soap:Fault>
</soap:Body>
</soap:Envelope>
SOAP inner error XSD
<?xml version="1.0" encoding="utf-8"?>
<xs:schema targetNamespace="http://tempuri.org/" xmlns:mstns="http://tempuri.org/"
xmlns="http://tempuri.org/" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata"
attributeFormDefault="qualified" elementFormDefault="qualified">
<xs:element name="Error">
<xs:complexType>
<xs:sequence>
<xs:element name="ErrorMessage" type="xs:string" minOccurs="1"/>
<xs:element name="ErrorNumber" type="xs:string" minOccurs="1"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:schema>
SOAP inner error XML message example
<Error xmlns="http://tempuri.org/">
<ErrorMessage>Ready for new version</ErrorMessage>
<ErrorNumber>1</ErrorNumber>
</Error>
5.10 GetAllFreeSlotsForProcedureHOS
--
Method used to get free slots for procedure from HOS.
With this method COS gets information about free slots for procedure in the facility.
GetAllFreeSlotsForProcedureRequestHOS
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd" />
<xs:element name="GetAllFreeSlotsForProcedureRequestHOS">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="MedicalFacilityCode" type="BPIType" />
<xs:element minOccurs="0" maxOccurs="1" name="MedicalFacilitySpecificCode" type="BPIspecificType" />
<xs:element minOccurs="1" maxOccurs="1" name="MedicalProcedureCode" type="MedicalProcedureCodeType" />
<xs:element minOccurs="0" maxOccurs="1" name="PageNumber" type="xs:integer" />
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<GetAllFreeSlotsForProcedureRequestHOS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<MedicalFacilityCode>12681</MedicalFacilityCode>
<MedicalFacilitySpecificCode>12681B</MedicalFacilitySpecificCode>
<MedicalProcedureCode>1056P</MedicalProcedureCode>
</GetAllFreeSlotsForProcedureRequestHOS>
Element Descriptions:
| Element name |
Element description |
Mandatory |
| MedicalFacilityCode |
Medical facility code (BPI) |
YES |
| MedicalFacilitySpecificCode |
Medical facility specific code (Used when multiple software vendors maintain the IS of the same facility) |
Only if exists |
| MedicalProcedureCode |
Medical procedure unique identifier (VZS) |
YES |
| PageNumber |
Page number (used with Paging) |
Only if paging used |
GetAllFreeSlotsForProcedureResponseHOS
XSD Schema:
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd"/>
<xs:element name="MedicalProcedureContact">
<xs:complexType>
<xs:all>
<xs:element minOccurs="0" maxOccurs="1" name="MPContactBPI" type="NonEmptyString" />
<xs:element minOccurs="0" maxOccurs="1" name="MPContactName" type="NonEmptyString" />
<xs:element minOccurs="0" maxOccurs="1" name="MPContactSurname" type="NonEmptyString" />
<xs:element minOccurs="0" maxOccurs="1" name="MPContactEmail" type="EmailType" />
<xs:element minOccurs="0" maxOccurs="1" name="MPContactTeamBPI" type="NonEmptyString" />
</xs:all>
</xs:complexType>
</xs:element>
<xs:complexType name="DiagnosisListType">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" name="Diagnosis" type="ReferralDiagnosisType"/>
</xs:sequence>
</xs:complexType>
<xs:element name="SlotInfo">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="ResponseCode" type="ResponseCodeType"/>
<xs:element minOccurs="0" maxOccurs="1" name="SlotDateTime" type="xs:dateTime"/>
<xs:element minOccurs="0" maxOccurs="1" name="SlotEndDateTime" type="xs:dateTime"/>
<xs:element minOccurs="0" maxOccurs="1" name="Urgency" type="UrgencyTypeForRefType"/>
<xs:element minOccurs="0" maxOccurs="1" name="LocationIdentifier" type="NonEmptyString"/>
<xs:element minOccurs="0" maxOccurs="1" name="DocIdentifier" type="NonEmptyString"/>
<xs:element minOccurs="0" maxOccurs="1" name="CareTeamIdentifier" type="xs:string"/>
<xs:element minOccurs="0" maxOccurs="1" name="DeviceIdentifier" type="xs:string"/>
<xs:element minOccurs="0" maxOccurs="1" name="PatientGender" type="PatientGenderType"/>
<xs:element minOccurs="0" maxOccurs="1" name="PatientAgeFrom" type="xs:integer"/>
<xs:element minOccurs="0" maxOccurs="1" name="PatientAgeTill" type="xs:integer"/>
<xs:element minOccurs="0" maxOccurs="1" name="DiagnosisList" type="DiagnosisListType"/>
<xs:element minOccurs="0" maxOccurs="1" name="OfficeBusinessHours" type="NonEmptyString"/>
<xs:element minOccurs="0" maxOccurs="1" name="AdditionalNotes" type="NonEmptyString"/>
</xs:all>
</xs:complexType>
</xs:element>
<xs:complexType name="SlotListType">
<xs:sequence>
<xs:element minOccurs="0" maxOccurs="unbounded" ref="SlotInfo"/>
</xs:sequence>
</xs:complexType>
<xs:element name="PagingInfo">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="1" maxOccurs="1" name="PageNumber" type="xs:integer"/>
<xs:element minOccurs="1" maxOccurs="1" name="PageSize" type="xs:integer"/>
<xs:element minOccurs="1" maxOccurs="1" name="RemainingNumber" type="xs:integer"/>
<xs:element minOccurs="1" maxOccurs="1" name="TotalNumber" type="xs:integer"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="GetAllFreeSlotsForProcedureResponseHOS">
<xs:complexType>
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="SuccessStatus" type="SuccessStatusType"/>
<xs:element minOccurs="0" maxOccurs="1" name="ErrorList" type="ErrorListType"/>
<xs:element minOccurs="0" maxOccurs="1" name="MedicalFacilityCode" type="BPIType"/>
<xs:element minOccurs="0" maxOccurs="1" name="MedicalFacilitySpecificCode" type="BPIspecificType"/>
<xs:element minOccurs="0" maxOccurs="1" name="MedicalProcedureCode" type="MedicalProcedureCodeType"/>
<xs:element minOccurs="0" maxOccurs="1" ref="PagingInfo"/>
<xs:element minOccurs="0" maxOccurs="1" name="SlotList" type="SlotListType"/>
<xs:element minOccurs="0" maxOccurs="1" ref="MedicalProcedureContact"/>
</xs:all>
</xs:complexType>
</xs:element>
</xs:schema>
XML Example:
<?xml version="1.0" encoding="utf-8"?>
<GetAllFreeSlotsForProcedureResponseHOS xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SuccessStatus>1</SuccessStatus>
<MedicalFacilityCode>12681</MedicalFacilityCode>
<MedicalFacilitySpecificCode>12681B</MedicalFacilitySpecificCode>
<MedicalProcedureCode>1020K</MedicalProcedureCode>
<PagingInfo>
<PageNumber>1</PageNumber>
<PageSize>100</PageSize>
<RemainingNumber>3</RemainingNumber>
<TotalNumber>100</TotalNumber>
</PagingInfo>
<SlotList>
<SlotInfo>
<ResponseCode>01</ResponseCode>
<SlotDateTime>2026-10-15T08:30:00</SlotDateTime>
<SlotEndDateTime>2026-10-15T09:00:00</SlotEndDateTime>
<Urgency>4</Urgency>
<LocationIdentifier>123456</LocationIdentifier>
<DocIdentifier>12345</DocIdentifier>
<CareTeamIdentifier>123</CareTeamIdentifier>
<DeviceIdentifier>1234567</DeviceIdentifier>
<PatientGender>1</PatientGender>
<PatientAgeFrom>18</PatientAgeFrom>
<PatientAgeTill>65</PatientAgeTill>
<DiagnosisList>
<Diagnosis>A20</Diagnosis>
<Diagnosis>I20</Diagnosis>
</DiagnosisList>
<OfficeBusinessHours>OfficeBusinessHours1</OfficeBusinessHours>
<AdditionalNotes>AdditionalNotes1</AdditionalNotes>
</SlotInfo>
<SlotInfo>
<ResponseCode>02</ResponseCode>
<SlotDateTime>2026-10-15T08:30:00</SlotDateTime>
<Urgency>4</Urgency>
</SlotInfo>
<SlotInfo>
<ResponseCode>02</ResponseCode>
<SlotDateTime>2026-10-10T08:30:00</SlotDateTime>
<Urgency>3</Urgency>
</SlotInfo>
<SlotInfo>
<ResponseCode>02</ResponseCode>
<SlotDateTime>2026-10-10T08:30:00</SlotDateTime>
<Urgency>2</Urgency>
</SlotInfo>
<SlotInfo>
<ResponseCode>04</ResponseCode>
<Urgency>4</Urgency>
</SlotInfo>
</SlotList>
<MedicalProcedureContact>
<MPContactBPI>01254</MPContactBPI>
<MPContactName>Doktor</MPContactName>
<MPContactSurname>Primarni</MPContactSurname>
<MPContactEmail>procedure.office@medical.com</MPContactEmail>
<MPContactTeamBPI>12345</MPContactTeamBPI>
</MedicalProcedureContact>
</GetAllFreeSlotsForProcedureResponseHOS>
Element Descriptions:
Slot details:
| Element name |
Element description |
Mandatory |
| ResponseCode |
Response code indicating the result of the slot request (References catalogue ResponseCodeType) |
YES |
| SlotDateTime |
Date and time when slot starts |
YES if ResponseCode is 01 or 02 |
| SlotEndDateTime |
Date and time when slot ends |
YES if ResponseCode is 01 |
| Urgency |
References catalogue UrgencyCodeType(#urgencycodetype) |
YES if ResponseCode is 01, 02, 05 or 06 |
| LocationIdentifier |
Location identifier |
YES if ResponseCode is 01 |
| DocIdentifier |
Doctor identifier |
NO |
| CareTeamIdentifier |
Care team identifier |
NO |
| DeviceIdentifier |
Device identifier |
NO |
| PatientGender |
Gender of the patient for which the slot is applicable (References catalogue PatientGenderType) |
NO |
| PatientAgeFrom |
Minimum patient age for which the slot is applicable |
NO |
| PatientAgeTill |
Maximum patient age for which the slot is applicable |
NO |
| DiagnosisList |
Contains Diagnosis node |
NO |
| AdditionalNotes |
Additional notes about facility |
NO |
| OfficeBusinessHours |
Facility work time |
NO |
For each type of ResponseCode, it is possible to send up to 1000 slots.
If exact or tentative slots are sent, you must also send 3 basic tentative slots (one for each urgency level: regular, urgent, and very urgent). Basic time slots are those without diagnoses.
Diagnosis details:
| Element name |
Element description |
Mandatory |
| Diagnosis |
Diagnosis indentifier code |
YES |
Paging details:
| Element name |
Element description |
Mandatory |
| PageNumber |
The number of page for which appointments were returned |
Yes if paging is used |
| PageSize |
Number of appointments sent in current page/response |
Yes if paging is used |
| RemainingNumber |
Number of appointments not yet sent to COS; if value is 0, paging is complete and all appointments are considered sent to COS |
Yes if paging is used |
| TotalNumber |
Total number of appointments for current medical procedure (sum of appointments across all pages) |
Yes if paging is used |
| Element name |
Element description |
Mandatory |
| MPContactBPI |
Medical procedure Contact |
NO |
| MPContactName |
Name of the person responsible for the medical procedure in the facility |
NO |
| MPContactSurname |
Surname of the person responsible for the medical procedure in the facility |
NO |
| MPContactEmail |
Email address of the person responsible for the medical procedure in the facility |
NO |
| MPContactTeamBPI |
Team BPI of the person responsible for the medical procedure in the facility |
NO |
Common:
| Element Name |
Element Description |
Mandatory |
| SuccessStatus |
References catalogue SuccessStatus |
YES |
| ErrorList |
List of errors |
If 'SuccessStatus' is set to 'Fail' |
| MedicalFacilityCode |
Medical facility code (BPI) |
If 'SuccessStatus' is set to 'Success' |
| MedicalFacilitySpecificCode |
Medical facility specific code (Used when multiple software vendors maintain the IS of the same facility) |
If 'SuccessStatus' is set to 'Success' and if exists |
| MedicalProcedureCode |
Medical procedure unique identifier (VZS) |
If 'SuccessStatus' is set to 'Success' |
| ResponseCode |
Code of the booked slot type (References catalogue ResponseCodeType(#responsecodetype)) |
If 'SuccessStatus' is set to 'Success' |
| PagingInfo |
Paging details |
If paging is used and 'SuccessStatus' is 'Success' |
| SlotList |
Contains Slot node |
If 'SuccessStatus' is set to 'Success' |
| MedicalProcedureContact |
Details about the person responsible for medical procedure in facility |
NO |
6. CATALOGUES
6.1 AppointmentCancellationReasonType
| Name |
Xml value |
Code |
Justified |
Internal |
| Zaradi sprememb mediciskih indikacij storitev za pacienta ni več potrebna |
1 |
1 |
YES |
NO |
| Pacient bo opravil storitev drugdje (pri drugi ustanovi, zasebniku…) |
2 |
2 |
YES |
NO |
| Pacient je opravil storitev drugdje (pri drugi ustanovi, zasebniku, v tujini…) |
3 |
3 |
YES |
NO |
| Pacient odpovedal storitev na lastno željo |
4 |
4 |
YES |
NO |
| Pacient ni odpovedal termina |
5 |
5 |
YES |
NO |
| Storitev opravljena kod nujna |
6 |
6 |
YES |
NO |
| Smrt pacienta |
7 |
7 |
YES |
NO |
| Ostalo |
8 |
8 |
YES |
NO |
| Uvrstitev napotne listine v napačno čakalno knjigo, urnik, seznam, … |
9 |
9 |
YES |
NO |
| Samodejna odpoved naročila |
10 |
10 |
YES |
YES |
| Brez navedbe razlogov |
11 |
11 |
NO |
NO |
| Nepredvidena hospitalizacija pacienta ali ožjega družinskega člana, ki onemogoča prihod pacienta na termin |
12 |
12 |
YES |
NO |
| Nenadana bolezen, poškodba ali zdravstveno stanje pacienta ali ožjega družinskega člana, ki onemogoča prihod |
13 |
13 |
YES |
NO |
| Smrt ožjega družinskega člana pacienta |
14 |
14 |
YES |
NO |
| Želja pacienta po črtanju s čakalnega seznama |
15 |
15 |
YES |
NO |
| Pacientova zavrnitev izvedbe zdravstvene storitve |
16 |
16 |
YES |
NO |
| Zdravstveno stanje pacienta ne omogoča izvedbe zdravstvene storitve, zaradi katere je uvrščen na čakalni seznam |
17 |
17 |
YES |
NO |
| Neopravičena odsotnost od termina |
18 |
18 |
YES |
NO |
| Druga ali katera koli naslednja uvrstitev na čakalni seznam za isto zdravstveno storitev |
19 |
19 |
YES |
NO |
| Reaktivacija napotne listine znotraj 35 dni od datuma termina. |
20 |
20 |
YES |
NO |
6.2 AppointmentStatusType
| Name |
Xml value |
Code |
| Vpisan |
1 |
CONF |
| V izvajanju |
2 |
INPR |
| Izveden |
3 |
DONE |
| Preklican |
4 |
CANC |
6.3 AppointmentType
| Name |
Xml value |
Code |
| Urnik |
1 |
SCH |
| Okvirni termin |
2 |
ORD |
6.4 Attachment Type
Supported Formats:
- Pdf
- Doc
- Docx
- Txt
- Jpg
- Gif
6.5 CancellationGroundedType
| Name |
Xml value |
Code |
| Utemeljeno |
1 |
1 |
| Neutemeljeno |
2 |
2 |
6.6 CancellationSourceType
| Name |
Xml value |
Code |
| Preklical pacijent |
1 |
1 |
| Preklicala ustanova |
2 |
2 |
| Preklical centralni sistem eNaročanje |
3 |
3 |
6.7 Class code
| Code |
Display Name |
codingScheme |
Primeri tipov dokumentov: |
Uporaba |
| 1 |
Klinični zapis |
IH-eZdravje |
Odpustno pismo, Ambulantni zapisnik, Povzetek zdravljenja |
N |
| 2 |
Anamneza |
IH-eZdravje |
Cepljenje, Alergije, ... (predvsem povzetki) |
N |
| 3 |
Laboratorijska diagnostika |
IH-eZdravje |
Laboratorijski izvid, Cito., Pato., Klinični Lab. |
N |
| 4 |
Funkcionalna diagnostika |
IH-eZdravje |
Izvid EEG, EMG, Endoskopski, Aspiracijska biopsija kostnega mozga |
N |
| 5 |
Slikovna diagnostika |
IH-eZdravje |
Izvid CT, MR, UZ, RTG |
N |
| 6 |
Recepti |
IH-eZdravje |
|
N |
| 7 |
Potrdila |
IH-eZdravje |
|
N |
| 8 |
Napotnice |
IH-eZdravje |
Napotnica, Termin obiska |
N |
| 57016-8 |
Izjave o zasebnosti |
2.16.840.1.113883.6.1 |
Izjava o zauponsti |
S |
| 1.3.6.1.4.1.19376.1.2.1.1.1 |
Digital Signature |
URN |
Podpis dokumenta |
P |
Last version can be found: https://confluence.marand.si/display/IHAPI/DocumentClass
6.8 DoctorType
| Name |
Xml value |
Code |
AtCode |
| Osebni |
1 |
1 |
at0.4 |
| Nadomestni |
2 |
2 |
at0.5 |
| NMP |
3 |
3 |
at0.6 |
| Napotni |
4 |
4 |
at0.7 |
6.9 MedicallyConditionedType
| Name |
Xml value |
Code |
| Medicinska indikacija za preiskavo ob točno določenem času (pregled/preiskava vezana na določeno obdobje) |
1 |
1 |
| Medicinska indikacija za izvedbo pred drugo zdravstveno storitvijo (operacijo ali kontrolimm pregledom) |
2 |
2 |
| Vezano na potreb prethodne preiskave |
3 |
3 |
| Uvrstitev na podlagi internih triažnih kriterijev oz. pridruženega stanja pacienta v okviru stope nujnosti |
4 |
4 |
6.10 PatientGenderType
| Name |
Xml value |
Code |
AtCode |
| Moški |
1 |
M |
at0020 |
| Ženski |
2 |
F |
at0021 |
| Neznan |
3 |
N |
at0022 |
6.11 ReferralActionType
| Name |
Xml value |
Code |
| Create |
1 |
1 |
| Update |
2 |
2 |
| Cancel |
3 |
3 |
6.12 ReferralCancellationReasonType
| Name |
Xml value |
Code |
AtCode |
Internal |
| Napotna listina izdana z napačnimi podatki (napačen vnos) |
1 |
1 |
at0.0.54 |
NO |
| Storitev opravljena kot nujna |
2 |
2 |
at0.0.55 |
NO |
| Pacient opravil storitev pri zasebniku |
3 |
3 |
at0.0.56 |
NO |
| Pacient opravil storitev v tujini |
4 |
4 |
at0.0.57 |
NO |
| Pacient odpovedal storitev na lastno željo |
5 |
5 |
at0.0.58 |
NO |
| Zaradi sprememb medicinskih indikacij storitev za pacienta ni več potrebna |
6 |
6 |
at0.0.59 |
NO |
| Smrt pacienta |
7 |
7 |
at0.0.60 |
NO |
| Ostalo |
8 |
8 |
at0.0.61 |
NO |
| Napotna listina je zaključena v skladu s 15.b členom Zakona o pacientovih pravicah. |
9 |
9 |
|
YES |
| Napotna listina je zaključena, ker je pacient umrl. |
10 |
10 |
|
YES |
| Napotna listina je zaključena, ker je potekel rok za naročanje. |
11 |
11 |
|
YES |
| Napotna listina je zaključena, ker je potekla veljavnost. |
12 |
12 |
|
YES |
| Preklic zaradi NR |
13 |
13 |
|
YES |
| Napotna listina je zaključena, ker je bilo eno naročilo preklicano brez opravičljivega razloga. |
14 |
14 |
|
YES |
| Napotna listina je zaključena, ker kontrola ni več potrebna. |
15 |
15 |
|
YES |
6.13 ReferralGroundedType
| Name |
Xml value |
Code |
| Utemeljeno |
1 |
1 |
| Neutemeljeno |
2 |
2 |
6.14 ReferralReasonType
| Name |
Xml value |
Code |
AtCode |
| Bolezen |
1 |
1 |
at0.0.4 |
| Poškodba izven dela |
2 |
2 |
at0.0.5 |
| Poklicna bolezen |
3 |
3 |
at0.0.6 |
| Poškodba pri delu |
4 |
4 |
at0.0.7 |
| Poškodba izven dela po tretji osebi |
5 |
5 |
at0.0.8 |
| Transplatacija |
6 |
7 |
at0.0.9 |
6.15 ReferralStatusType
| Name |
Xml value |
Code |
| Izdana (Created) |
1 |
1 |
| Vpisana (Scheduled) |
2 |
2 |
| Izvedena (Done) |
11 |
11 |
| Izkoriščena (Used) |
4 |
4 |
| Neizkoriščena (NotUsed) |
5 |
5 |
| Preklicana (Cancelled) |
6 |
6 |
Status descriptions:
- Izdana – there are no appointments or are all appointments are cancelled
- Vpisana – there is one (ore more) active appointment in the same facility
- Izvedena – all appointments are completed, but the referral is still valid
- Izkoriščena – no longer valid, has completed appointments
- Neizkoriščena – no longer valid, no appointment were completed
- Preklicana – cancelled
6.16 ReferralValidityType
| Name |
Xml value |
Code |
AtCode |
| Enkratno |
1 |
1 |
at0.0.0.65 |
| Za obdobje |
2 |
2 |
at0.0.0.66 |
| Do zaključka zdravljenja |
3 |
3 |
at0.0.0.67 |
6.17 RequestedByPatientType
| Name |
Xml value |
Code |
| Kasnejši termin na željo pacienta |
1 |
1 |
| Prestavljen termin na željo pacienta |
2 |
2 |
| Prestavljen termin iz razlogov na strani ustanove |
3 |
3 |
| Zgodnejši termin na zahtevo zdravnika ZZZS |
4 |
4 |
6.18 ReservationSourceType
| Name |
Xml value |
Code |
| Osebno |
1 |
1 |
| Pisno |
2 |
2 |
| Preko telefona |
3 |
3 |
| Preko elektronske pošte |
4 |
4 |
| eNaročanje |
5 |
5 |
| Spletna stran izvajalca |
6 |
6 |
6.19 ResponseCodeType
| Name |
Xml value |
Code |
AtCode |
| Fiksni termin |
1 |
01 |
at0007 |
| Okvirni termin |
2 |
02 |
at0008 |
| Ustanova ne pruža uslugu |
3 |
03 |
|
| Nema slobodnih termina |
4 |
04 |
|
| Slobodan prijem |
5 |
05 |
|
| Usluga se pruža u sklopu nadređene usluge |
6 |
06 |
|
6.20 StatisticalRegionCode
| Name |
Xml value |
Code |
| Pomurska regija |
1 |
01 |
| Podravska |
2 |
02 |
| Koroška |
3 |
03 |
| Savinjska |
4 |
04 |
| Zasavska |
5 |
05 |
| Posavska |
6 |
06 |
| Jugovzhodna Slovenja |
7 |
07 |
| Osrednjeslovenska regija |
8 |
08 |
| Gorenjska regija |
9 |
09 |
| Primorsko-notranjska regija |
10 |
10 |
| Goriška regija |
11 |
11 |
| Obalno-kraška regija |
12 |
12 |
6.21 TaskType
| Name |
Xml value |
Code |
| UpdateReferral |
1 |
1 |
| Consultation |
2 |
2 |
| CancelReferral |
3 |
3 |
| UpdateUrgencyCode |
4 |
4 |
| CreateReferral |
5 |
5 |
6.22 TaskTypeCategory
| Name |
Xml value |
Code |
| Request |
1 |
1 |
| Notification |
2 |
2 |
6.23 TaskStatusType
| Name |
Xml value |
Code |
| Open |
1 |
1 |
| Closed |
2 |
2 |
6.24 TerminationActionType
| Name |
Xml value |
Code |
| ReferralRealisation |
1 |
1 |
| ReferralTermination |
2 |
2 |
6.25 Type code (attachments)
| Code |
Display Name |
codingScheme |
Uporaba |
| 18842-5 |
Odpustno pismo |
2.16.840.1.113883.6.1 |
N |
| 51845-6 |
Ambulantni izvid |
2.16.840.1.113883.6.1 |
N |
| 57833-6 |
Predpis (zdravila) |
2.16.840.1.113883.6.1 |
N |
| 60593-1 |
Izdaja (zdravila) |
2.16.840.1.113883.6.1 |
N |
| 57133-1 |
Napotnica |
2.16.840.1.113883.6.1 |
N |
| 11502-2 |
Laboratorijski izvid |
2.16.840.1.113883.6.1 |
N |
| 18747-6 |
Izvid CT |
2.16.840.1.113883.6.1 |
N |
| 18755-9 |
Izvid MR |
2.16.840.1.113883.6.1 |
N |
| 18760-9 |
Izvid UZ |
2.16.840.1.113883.6.1 |
N |
| 18757-5 |
Izvid nuklearne medicine |
2.16.840.1.113883.6.1 |
N |
| 18758-3 |
Izvid PET |
2.16.840.1.113883.6.1 |
N |
| 18782-3 |
Izvid RTG |
2.16.840.1.113883.6.1 |
N |
| 11369-6 |
Zgodovina cepljenj |
2.16.840.1.113883.6.1 |
N |
| eRCO_Vaccination_Record |
Zapis o cepljenju |
eRCO |
N |
| eRCO_Vaccination_Adverse_Reaction_Record |
Prijava neželenih učinkov |
eRCO |
N |
| eRCO_Vaccination_Suspension |
Opustitev cepljenja |
eRCO |
N |
| eOskrba_Chronic_Care_Summary |
Povzetek stanja kronične bolezni |
eOskrba |
N |
| 57016-8 |
Izjava o zasebnosti |
2.16.840.1.113883.6.1 |
S |
| 60591-5 |
Povzetek podatkov o pacientu (Patient Summary) |
2.16.840.1.113883.6.1 |
N |
Last version can be found: https://confluence.marand.si/display/IHAPI/DocumentType
6.26 UrgencyCodeType
| Name |
Xml value |
Code |
AtCode |
| Nujno |
1 |
1 |
at0137 |
| Hitro |
2 |
2 |
at0.0.44 |
| Redno |
3 |
3 |
at0.0.45 |
| Zelo hitro |
4 |
4 |
at0.0.62 |
6.27 UrgencyGroundedType
| Name |
Xml value |
Code |
| Utemeljeno |
1 |
1 |
| Neutemeljeno |
2 |
2 |
6.28 ErrorCodeType
| Name |
Xml value |
Code |
| Sistemska napaka |
0 |
0 |
| Napaka v bolnisnicnem sistemu narocanja |
0001 |
0001 |
| Napaka v centralnem sistemu narocanja |
0002 |
0002 |
| Uporabnik nima dovoljenja za dejanje. |
0008 |
0008 |
| Bolnišnični sistem za naročanje ni dostopen |
0009 |
0009 |
| Metoda ni podprta v bolnišničnem sistemu narocanja |
0011 |
0011 |
| Napaka v komunikaciji |
1 |
1 |
| Napaka v definiciji sheme XML |
1001 |
1001 |
| Storitev ni na voljo |
1002 |
1002 |
| Komunikacija s IH ni mozna |
1003 |
1003 |
| Napaka v validaciji podatkov |
2 |
2 |
| Obvezno polje ni izpolnjeno |
2001 |
2001 |
| Napaka v formatu podatkov |
2002 |
2002 |
| Napotne listine ni mogoce spreminjati |
2003 |
2003 |
| Ni mozno imeti dveh aktivnih napotnih listinin za isto storitev |
2004 |
2004 |
| Ni mozno preklicati napotitev ki je imel sprejem |
2005 |
2005 |
| Poteklo je obdobje v katerem je bilo možno naročanje |
2006 |
2006 |
| Pacient ne obstaja v RDSP |
2007 |
2007 |
| Pacient kontakt ne obstaja v RDSP |
2008 |
2008 |
| Kontakni podatak pacienta ne obstaja v RDSP |
2009 |
2009 |
| Zdravnik ne obstaja v RDSP |
2010 |
2010 |
| Kontaktni podatek zdravnika ne obstaja v RDSP |
2011 |
2011 |
| Omejitev zdravstvene storitve po spolu |
3001 |
3001 |
| Omejitev zdravstvene storitve po diagnozi |
3002 |
3002 |
| Omejitev zdravstvene storitve po starosti |
3003 |
3003 |
| E-narocanje ni mozno za to storitev |
3004 |
3004 |
| E-narocanje ni mozno za to stopnjo nujnosti -- |
3005 |
3005 |
| Storitev ni aktiven |
3006 |
3006 |
| Nepravilni status napotne listine |
3007 |
3007 |
| Nepravilni status narocila |
3008 |
3008 |
| Narocilo ni v ista ustanova kot prejsnje narocilo. |
3009 |
3009 |
| E-narocanje ni mozno po prvem izkoriscanju. |
3010 |
3010 |
| E-napotna listina ni dovoljena za to zdravstveno storitev! |
3012 |
3012 |
| Realizacije ni mogoče prijaviti, ker je preteklo več kot 30 dni od izteka napotne listine. |
3013 |
3013 |
| Napotna listina ne obstaja. |
4 |
4 |
| Nepodprta verzija |
6 |
6 |
| Narocilo ne obstaja. |
7 |
7 |
| Napaka pri pošiljanju e-pošte in sms-a |
8 |
8 |
6.29 SuccessStatus
| Name |
Xml value |
Code |
| Success |
1 |
1 |
| Fail |
2 |
2 |
| Partial |
3 |
3 |
Note:
Partial status can only be applied for CancelAppointments, CreateAppointments and UpdateAppointments when there is the possibility that during the processing some appointments can be processed and some not.
Example: COS receives a CancelAppointments method call with 5 appointments and 2 appointments have some validation errors. In that case, COS will regularly process the 3 valid appointments and for the invalid ones, the details will be provided in the Error section of the response.
6.30 ChronicConditionesTypes
| Code |
MKB |
Name |
| 1 |
I48 |
Preddvorna fibrilacija in undulacija |
| 2 |
Z95.2 |
Prisotnost umetne srčne zaklopke |
| 3 |
C43 |
Maligni melanom kože |
| 4 |
L40 |
Psoriaza (luskavica) |
| 5 |
L20 |
Atopijski dermatitis |
| 6 |
E10 |
Sladkorna bolezen tipa 1 |
| 7 |
E11 |
Sladkorna bolezen tipa 2 |
| 8 |
K50 - K51 |
Kronična vnetna črevesna bolezen |
| 9 |
C91 |
Limfatična levkemija |
| 10 |
C92 |
Mieloična levkemija |
| 11 |
D45 |
Policitemija rubra vera |
| 12 |
D75.2 |
Esencialna trombocitoza |
| 13 |
D55 – D59 |
Hemolitične anemije (hemoglobinpatije) |
| 14 |
B20 - B24 |
HIV |
| 15 |
B18 |
Kronični virusni hepatitis (B, C) |
| 16 |
Z95 |
Prisotnost srčnega spodbujevalnika |
| 17 |
I50.0 |
Srčno popuščanje |
| 18 |
I42.0 |
Dilatativna kardiomiopatija |
| 19 |
N18.3 – N18.5 |
Kronična ledvična bolezen (KLB), stopnja 3 - 5 |
| 20 |
Z99.2 |
Odvisnost od ledvične dialize |
| 21 |
G35 - G37 |
Demielinizacijske bolezni centralnega živčevja |
| 22 |
G40 |
Epilepsija |
| 23 |
G70 - G73 |
Bolezni živčnomišičnega stika in mišičja |
| 24 |
I69 |
Posledice cerebrovaskularne bolezni |
| 25 |
H30 – H36 |
Okvare žilnice in mrežnice |
| 26 |
H40 |
Glavkom |
| 27 |
H35.3 |
Degeneracija makule in zadajšnega pola |
| 28 |
|
Lokalizirano ali razširjeno rakavo obolenje |
| 29 |
F20 – F29 |
Shizofrenija, shizotipske in blodnjave motnje |
| 30 |
F32.2 |
Ponavljajoča se depresivna motnja, trenutna epizoda je huda, brez psihotičnih simptomov |
| 31 |
F33.3 |
Ponavljajoča se depresivna motnja, trenutna epizoda je huda, s psihotičnimi simptomi |
| 32 |
J44.9 |
KOPB |
| 33 |
E84 |
Cistična fibroza |
| 34 |
J81.1 |
Intersticijska pljučna fibroza |
| 35 |
M05 |
Seropozitivni revmatoidni artritis |
| 36 |
M06 |
Seronegativni revmatoidni artritis |
| 37 |
M45 |
Ankilozirajoči spondilitis |
| 38 |
M30 – M36 |
Sistemske vezivnotkivne bolezni |
6.31 PageSizeTypes
| Name |
Xml value |
Code |
| A4 |
A4 |
A4 |
| A5 |
A5 |
A5 |
6.32 ProcessType
| Name |
Xml value |
Code |
| Appointments Fetch |
APF |
APF |
| Appointments Realisations and Cancellation Fetch |
ARCF |
ARCF |
6.33 ReorderingReason
| Name |
Xml value |
Code |
| Prenaročanje zaradi koeficijenta |
1 |
1 |
6.34 DocumentType
| Name |
Xml value |
Code |
| Napotitev |
0 |
0 |
| DN - delovna terapija |
1 |
1 |
| DN - nega na domu |
2 |
2 |
| DN - storitve psihologa, logopeda, defektologa |
3 |
3 |
| DN - rentgensko slikanje |
4 |
4 |
| DN - laboratorijske in druge storitve |
5 |
5 |
| DN - farmacevtsko svetovanje |
6 |
6 |
| DN - fizioterapija |
7 |
7 |
7. ATTACHMENTS
7.1 Common.xsd
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:simpleType name="AppointmentUnqIdenType">
<xs:restriction base="xs:string">
<xs:pattern value="[0-9]{15,19}"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ReferralUidType">
<xs:restriction base="xs:string">
<xs:length value="13"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="NonEmptyString">
<xs:restriction base="xs:string">
<xs:minLength value="1"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ReferralActionType">
<xs:restriction base="xs:string">
<xs:enumeration value="1"/>
<xs:enumeration value="2"/>
<xs:enumeration value="3"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="TerminationActionType">
<xs:restriction base="xs:string">
<xs:enumeration value="1"/>
<xs:enumeration value="2"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="CountryCodeType">
<xs:restriction base="xs:string">
<xs:length value="2"/>
</xs:restriction>
</xs:simpleType>
<xs:complexType name="ErrorListType">
<xs:sequence>
<xs:element name="Error" type="Error" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="InfoListType">
<xs:sequence>
<xs:element name="Info" type="Info" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="Error">
<xs:sequence>
<xs:element ref="Code"/>
<xs:element ref="Description"/>
<xs:element minOccurs="0" maxOccurs="1" name="AppointmentUniqueIdentifier" type="AppointmentUnqIdenType" nillable="true"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="Info">
<xs:sequence>
<xs:element ref="Description"/>
<xs:element minOccurs="0" maxOccurs="unbounded" name="AppointmentUniqueIdentifier" type="AppointmentUnqIdenType" nillable="true"/>
<xs:element minOccurs="0" maxOccurs="unbounded" name="ReferralUniqueIdentifier" type="ReferralUidType" nillable="true"/>
</xs:sequence>
</xs:complexType>
<xs:element name="Code" type="xs:int"/>
<xs:element name="Description" type="xs:string"/>
<xs:simpleType name="BPIType">
<xs:restriction base="xs:string">
<xs:pattern value="[0-9]{5}"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="BPIspecificType">
<xs:restriction base="xs:string">
<xs:pattern value="[0-9]{5}([A-Z]){1}"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="MedicalProcedureCodeType">
<xs:restriction base="xs:string">
<xs:pattern value="[0-9]{4}([A-Z]){0,1}"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="PatientUIdType">
<xs:restriction base="xs:string">
<xs:pattern value="[0-9]{13}"/>
<xs:pattern value="[a-zA-Z0-9]{16}"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="PatientInsIdType">
<xs:restriction base="xs:string">
<xs:pattern value="[0-9]{9}"/>
<xs:pattern value="[a-zA-Z0-9]{16}"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="BookerIdentifierType">
<xs:restriction base="xs:string">
<xs:pattern value="[0-9]{5}([0-9]{4})?"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="EmailType">
<xs:restriction base="xs:string">
<xs:pattern value="[^@]+@[^\.]+\..+"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ReferralDiagnosisType">
<xs:restriction base="xs:string">
<xs:pattern value="[a-zA-Z][0-9][a-zA-Z0-9](\.[a-zA-Z0-9]{1,4}){0,1}"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="UrgencyTypeForAppType">
<xs:restriction base="xs:string">
<xs:enumeration value="2"/>
<xs:enumeration value="3"/>
<xs:enumeration value="4"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="UrgencyTypeForRefType">
<xs:restriction base="xs:string">
<xs:enumeration value="1"/>
<xs:enumeration value="2"/>
<xs:enumeration value="3"/>
<xs:enumeration value="4"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ResponseCodeType">
<xs:restriction base="xs:string">
<xs:enumeration value="01"/>
<xs:enumeration value="02"/>
<xs:enumeration value="03"/>
<xs:enumeration value="04"/>
<xs:enumeration value="05"/>
<xs:enumeration value="06"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="TaskType">
<xs:restriction base="xs:string">
<xs:enumeration value="1"/>
<xs:enumeration value="2"/>
<xs:enumeration value="3"/>
<xs:enumeration value="4"/>
<xs:enumeration value="5"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ReferralValidityType">
<xs:restriction base="xs:string">
<xs:enumeration value="1"/>
<xs:enumeration value="2"/>
<xs:enumeration value="3"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="MedicallyConditionedType">
<xs:restriction base="xs:string">
<xs:enumeration value="1"/>
<xs:enumeration value="2"/>
<xs:enumeration value="3"/>
<xs:enumeration value="4"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="RequestedByPatientType">
<xs:restriction base="xs:string">
<xs:enumeration value="1"/>
<xs:enumeration value="2"/>
<xs:enumeration value="3"/>
<xs:enumeration value="4"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ReferralGroundedType">
<xs:restriction base="xs:string">
<xs:enumeration value="1"/>
<xs:enumeration value="2"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="AppointmentStatusType">
<xs:restriction base="xs:string">
<xs:enumeration value="CONF"/>
<xs:enumeration value="INPR"/>
<xs:enumeration value="DONE"/>
<xs:enumeration value="CANC"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="TaskStatusType">
<xs:restriction base="xs:string">
<xs:enumeration value="1"/>
<xs:enumeration value="2"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ReferralStatusType">
<xs:restriction base="xs:string">
<xs:enumeration value="1"/>
<xs:enumeration value="2"/>
<xs:enumeration value="11"/>
<xs:enumeration value="4"/>
<xs:enumeration value="5"/>
<xs:enumeration value="6"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="PatientGenderType">
<xs:restriction base="xs:string">
<xs:enumeration value="1"/>
<xs:enumeration value="2"/>
<xs:enumeration value="3"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ReferralReasonType">
<xs:restriction base="xs:string">
<xs:enumeration value="1"/>
<xs:enumeration value="2"/>
<xs:enumeration value="3"/>
<xs:enumeration value="4"/>
<xs:enumeration value="5"/>
<xs:enumeration value="7"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="DoctorType">
<xs:restriction base="xs:string">
<xs:enumeration value="1"/>
<xs:enumeration value="2"/>
<xs:enumeration value="3"/>
<xs:enumeration value="4"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="CancellationSourceType">
<xs:restriction base="xs:string">
<xs:enumeration value="1"/>
<xs:enumeration value="2"/>
<xs:enumeration value="3"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="CancellationGroundedType">
<xs:restriction base="xs:string">
<xs:enumeration value="1"/>
<xs:enumeration value="2"/>
</xs:restriction>
</xs:simpleType>
<xs:complexType name="ListOfAppointments">
<xs:sequence>
<xs:element minOccurs="1" maxOccurs="unbounded" name="AppointmentUniqueIdentifier" type="AppointmentUnqIdenType"/>
</xs:sequence>
</xs:complexType>
<xs:simpleType name="ReferralCancellationReasonType">
<xs:restriction base="xs:string">
<xs:enumeration value="1"/>
<xs:enumeration value="2"/>
<xs:enumeration value="3"/>
<xs:enumeration value="4"/>
<xs:enumeration value="5"/>
<xs:enumeration value="6"/>
<xs:enumeration value="7"/>
<xs:enumeration value="8"/>
<xs:enumeration value="9"/>
<xs:enumeration value="10"/>
<xs:enumeration value="11"/>
<xs:enumeration value="12"/>
<xs:enumeration value="13"/>
<xs:enumeration value="14"/>
<xs:enumeration value="15"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="PatientEUCardNumberLength">
<xs:restriction base="xs:string">
<xs: maxLength value="25"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="PatientDocumentNumberLength">
<xs:restriction base="xs:string">
<xs: maxLength value="25"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ReservationSourceTypeCode">
<xs:restriction base="xs:string">
<xs:enumeration value="1"/>
<xs:enumeration value="2"/>
<xs:enumeration value="3"/>
<xs:enumeration value="4"/>
<xs:enumeration value="5"/>
<xs:enumeration value="6"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ReorderingReasonTypeCode">
<xs:restriction base="xs:string">
<xs:enumeration value="1"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="AppointmentTypeCode">
<xs:restriction base="xs:string">
<xs:enumeration value="SCH"/>
<xs:enumeration value="ORD"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="InsuranceStateCode">
<xs:restriction base="xs:string">
<xs:pattern value="[A-Z]{2}|000|999"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="MedicalActivityFirstSecondTypeCode">
<xs:restriction base="xs:string">
<xs:pattern value="[0-9]{3}"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="AppointmentBookerCode">
<xs:restriction base="xs:string">
<xs:pattern value="[0-9]{5}"/>
<xs:pattern value="[0-9]{9}"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="StatisticalRegionCode">
<xs:restriction base="xs:string">
<xs:enumeration value="01"/>
<xs:enumeration value="02"/>
<xs:enumeration value="03"/>
<xs:enumeration value="04"/>
<xs:enumeration value="05"/>
<xs:enumeration value="06"/>
<xs:enumeration value="07"/>
<xs:enumeration value="08"/>
<xs:enumeration value="09"/>
<xs:enumeration value="10"/>
<xs:enumeration value="11"/>
<xs:enumeration value="12"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="UrgencyGroundedType">
<xs:restriction base="xs:string">
<xs:enumeration value="1"/>
<xs:enumeration value="2"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ErrorCodeType">
<xs:restriction base="xs:string">
<xs:enumeration value="0"/>
<xs:enumeration value="0001"/>
<xs:enumeration value="0002"/>
<xs:enumeration value="0008"/>
<xs:enumeration value="0009"/>
<xs:enumeration value="1"/>
<xs:enumeration value="1001"/>
<xs:enumeration value="1002"/>
<xs:enumeration value="1003"/>
<xs:enumeration value="2"/>
<xs:enumeration value="2001"/>
<xs:enumeration value="2002"/>
<xs:enumeration value="2003"/>
<xs:enumeration value="2004"/>
<xs:enumeration value="2005"/>
<xs:enumeration value="2006"/>
<xs:enumeration value="2007"/>
<xs:enumeration value="2008"/>
<xs:enumeration value="2009"/>
<xs:enumeration value="2010"/>
<xs:enumeration value="2011"/>
<xs:enumeration value="3"/>
<xs:enumeration value="3001"/>
<xs:enumeration value="3002"/>
<xs:enumeration value="3003"/>
<xs:enumeration value="3004"/>
<xs:enumeration value="3005"/>
<xs:enumeration value="3006"/>
<xs:enumeration value="3007"/>
<xs:enumeration value="3008"/>
<xs:enumeration value="3009"/>
<xs:enumeration value="3010"/>
<xs:enumeration value="3012"/>
<xs:enumeration value="3013"/>
<xs:enumeration value="4"/>
<xs:enumeration value="6"/>
<xs:enumeration value="7"/>
<xs:enumeration value="8"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="SuccessStatusType">
<xs:restriction base="xs:string">
<xs:enumeration value="1"/>
<xs:enumeration value="2"/>
<xs:enumeration value="3"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="PageSizeType">
<xs:restriction base="xs:string">
<xs:enumeration value="A4"/>
<xs:enumeration value="A5"/>
</xs:restriction>
</xs:simpleType>
<xs:complexType name="MedicalActivityListType">
<xs:sequence>
<xs:element name="MedicalActivity" type="MedicalActivityType" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<xs:simpleType name="MedicalActivityCodeType">
<xs:restriction base="xs:string">
<xs:length value="3"/>
</xs:restriction>
</xs:simpleType>
<xs:complexType name="MedicalActivityType">
<xs:sequence>
<xs:element minOccurs="1" maxOccurs="1" name="Code" type="MedicalActivityCodeType"/>
<xs:element minOccurs="0" maxOccurs="1" name="CodeSecond" type="MedicalActivityCodeType" nillable="true"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="GetMedicalActivityListType">
<xs:sequence>
<xs:element name="MedicalActivity" type="GetMedicalActivityType" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="GetMedicalActivityType">
<xs:sequence>
<xs:element minOccurs="1" maxOccurs="1" name="Code" type="MedicalActivityCodeType"/>
<xs:element minOccurs="1" maxOccurs="1" name="CodeSecond" type="MedicalActivityCodeType"/>
</xs:sequence>
</xs:complexType>
<xs:simpleType name="ProcessType">
<xs:restriction base="xs:string">
<xs:enumeration value="APF"/>
<xs:enumeration value="ARCF"/>
</xs:restriction>
</xs:simpleType>
</xs:schema>
7.2 AppointmentCancellationReasonsList.xsd
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:simpleType name="AppointmentCancellationReasonType">
<xs:restriction base="xs:string">
<xs:enumeration value="1"/>
<xs:enumeration value="2"/>
<xs:enumeration value="3"/>
<xs:enumeration value="4"/>
<xs:enumeration value="5"/>
<xs:enumeration value="6"/>
<xs:enumeration value="7"/>
<xs:enumeration value="8"/>
<xs:enumeration value="9"/>
<xs:enumeration value="10"/>
<xs:enumeration value="11"/>
<xs:enumeration value="12"/>
<xs:enumeration value="13"/>
<xs:enumeration value="14"/>
<xs:enumeration value="15"/>
<xs:enumeration value="16"/>
<xs:enumeration value="17"/>
<xs:enumeration value="18"/>
<xs:enumeration value="19"/>
<xs:enumeration value="20"/>
<xs:enumeration value="21"/>
<xs:enumeration value="22"/>
<xs:enumeration value="23"/>
</xs:restriction>
</xs:simpleType>
</xs:schema>
7.3 AppointmentSummary.xsd
<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:include schemaLocation="Common.xsd"/>
<xs:include schemaLocation="AppointmentCancellationReasonsList.xsd"/>
<xs:complexType name="AppointmentSummary">
<xs:all>
<xs:element minOccurs="1" maxOccurs="1" name="AppointmentUniqueIdentifier" type="AppointmentUnqIdenType"/>
<xs:element minOccurs="1" maxOccurs="1" name="MedicalFacilityName" type="xs:string"/>
<xs:element minOccurs="1" maxOccurs="1" name="MedicalFacilityAddress" type="xs:string"/>
<xs:element minOccurs="0" maxOccurs="1" name="MedicalFacilityPhone" type="xs:string"/>
<xs:element minOccurs="0" maxOccurs="1" name="MedicalFacilityFax" type="xs:string"/>
<xs:element minOccurs="0" maxOccurs="1" name="MedicalFacilityEMail" type="EmailType"/>
<xs:element minOccurs="0" maxOccurs="1" name="MedicalFacilityWebAddress" type="xs:string"/>
<xs:element minOccurs="1" maxOccurs="1" name="PatientNameAndSurname" type="xs:string"/>
<xs:element minOccurs="0" maxOccurs="1" name="StreetName" type="xs:string"/>
<xs:element minOccurs="0" maxOccurs="1" name="StreetNumber" type="xs:string"/>
<xs:element minOccurs="0" maxOccurs="1" name="CityName" type="xs:string"/>
<xs:element minOccurs="0" maxOccurs="1" name="CityPostalCode" type="xs:string"/>
<xs:element minOccurs="0" maxOccurs="1" name="DistrictCode" type="xs:string"/>
<xs:element minOccurs="0" maxOccurs="1" name="PatientUniqueIdentifier" type="PatientUIdType"/>
<xs:element minOccurs="1" maxOccurs="1" name="PatientInsuranceIdentifier" type="PatientInsIdType"/>
<xs:element minOccurs="0" maxOccurs="1" name="PatientPhone" type="xs:string"/>
<xs:element minOccurs="0" maxOccurs="1" name="PatientMobile" type="xs:string"/>
<xs:element minOccurs="0" maxOccurs="1" name="PatientEmail" type="xs:string"/>
<xs:element minOccurs="1" maxOccurs="1" name="MedicalProcedureName" type="xs:string"/>
<xs:element minOccurs="0" maxOccurs="1" name="AppointmentDateTime" type="xs:dateTime"/>
<xs:element minOccurs="0" maxOccurs="1" name="SiteDescription" type="xs:string"/>
<xs:element minOccurs="0" maxOccurs="1" name="MedicalFacilityNotes" type="xs:string"/>
<xs:element minOccurs="1" maxOccurs="1" name="ResponseCode" type="ResponseCodeType"/>
<xs:element minOccurs="0" maxOccurs="1" name="HOSIdentifier" type="xs:string"/>
<xs:element minOccurs="1" maxOccurs="1" name="HealthcareProviderIndex" type="BPIType"/>
<xs:element minOccurs="0" maxOccurs="1" name="HealthcareProviderSpecificIndex" type="BPIspecificType"/>
<xs:element minOccurs="1" maxOccurs="1" name="ReferralUniqueIdentifier" type="ReferralUidType"/>
<xs:element minOccurs="0" maxOccurs="1" name="OldReferralUniqueIdentifier" type="ReferralUidType"/>
<xs:element minOccurs="1" maxOccurs="1" name="AppointmentStatus" type="AppointmentStatusType"/>
<xs:element minOccurs="0" maxOccurs="1" name="CancelledBy" type="NonEmptyString"/>
<xs:element minOccurs="0" maxOccurs="1" name="CancellationReasonCode" type="AppointmentCancellationReasonType"/>
<xs:element minOccurs="0" maxOccurs="1" name="CancellationReasonDescription" type="xs:string"/>
<xs:element minOccurs="0" maxOccurs="1" name="CancelReferralFacilityCode" type="BPIType"/>
<xs:element minOccurs="0" maxOccurs="1" name="CancelReferralFacilitySpecificCode" type="BPIspecificType"/>
<xs:element minOccurs="1" maxOccurs="1" name="MedicalProcedureCode" type="MedicalProcedureCodeType"/>
<xs:element minOccurs="1" maxOccurs="1" name="ControlExam" type="xs:boolean"/>
<xs:element minOccurs="0" maxOccurs="1" name="RequestedByPatient" type="xs:boolean"/>
<xs:element minOccurs="0" maxOccurs="1" name="RequestedByPatientCode" type="RequestedByPatientType"/>
<xs:element minOccurs="0" maxOccurs="1" name="MedicallyConditioned" type="MedicallyConditionedType"/>
<xs:element minOccurs="1" maxOccurs="1" name="WantsSpecificDoctor" type="xs:boolean"/>
<xs:element minOccurs="1" maxOccurs="1" name="WasInformedOfOthers" type="xs:boolean"/>
<xs:element minOccurs="0" maxOccurs="1" name="MedicalProcedureIsNR" type="xs:boolean"/>
<xs:element minOccurs="0" maxOccurs="1" name="MedicalActivityList" type="GetMedicalActivityListType"/>
<xs:element minOccurs="0" maxOccurs="1" name="CancellationDateTime" type="xs: dateTime"/>
<xs:element minOccurs="0" maxOccurs="1" name="RealisationDateTime" type="xs: dateTime"/>
<xs:element minOccurs="0" maxOccurs="1" name="OfficeAddress" type="xs:string"/>
<xs:element minOccurs="0" maxOccurs="1" name="UrgencyType" type="xs:string"/>
<xs:element minOccurs="0" maxOccurs="1" name="ReasonForChangingUrgencyType" type="xs:string"/>
<xs:element minOccurs="0" maxOccurs="1" name="DocumentTypeCode" type="DocumentType" nillable="true"/>
<xs:element minOccurs="0" maxOccurs="1" name="CareTeamIdentifier" type="xs:string"/>
<xs:element minOccurs="0" maxOccurs="1" name="LocationIdentifier" type="xs:string"/>
<xs:element minOccurs="0" maxOccurs="1" name="DeviceIdentifier" type="xs:string"/>
<xs:element minOccurs="0" maxOccurs="1" name="DocIdentifier" type="xs:string"/>
</xs:all>
</xs:complexType>
</xs:schema>
7.4 WSDL COS V3
<?xml version="1.0" encoding="utf-8"?>
<wsdl:definitions xmlns:s="http://www.w3.org/2001/XMLSchema"
xmlns:soap12="http://schemas.xmlsoap.org/wsdl/soap12/"
xmlns:http="http://schemas.xmlsoap.org/wsdl/http/"
xmlns:mime="http://schemas.xmlsoap.org/wsdl/mime/"
xmlns:tns="http://IN2.Ordering.org/"
xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
xmlns:tm="http://microsoft.com/wsdl/mime/textMatching/"
xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"
targetNamespace="http://IN2.Ordering.org/" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">
<wsdl:types>
<s:schema elementFormDefault="qualified" targetNamespace="http://IN2.Ordering.org/">
<s:element name="RegisterConcessioner">
<s:complexType>
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="version" type="s:int"/>
<s:element minOccurs="0" maxOccurs="1" name="request" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="RegisterConcessionerResponse">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="RegisterConcessionerResult" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="RegisterProceduresForConcessioner">
<s:complexType>
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="version" type="s:int"/>
<s:element minOccurs="0" maxOccurs="1" name="request" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="RegisterProceduresForConcessionerResponse">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="RegisterProceduresForConcessionerResult" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="GetAEUCandidates">
<s:complexType>
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="version" type="s:int"/>
<s:element minOccurs="0" maxOccurs="1" name="request" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="GetAEUCandidatesResponse">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="GetAEUCandidatesResult" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="SecurityToken" type="tns:SecurityToken"/>
<s:complexType name="SecurityToken">
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="Token" type="s:base64Binary"/>
<s:element minOccurs="0" maxOccurs="1" name="IdBPI" type="s:string"/>
<s:element minOccurs="0" maxOccurs="1" name="IdBPIOrganization" type="s:string"/>
</s:sequence>
<s:anyAttribute/>
</s:complexType>
<s:element name="AppointmentRealisation">
<s:complexType>
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="version" type="s:int"/>
<s:element minOccurs="0" maxOccurs="1" name="request" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="AppointmentRealisationResponse">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="AppointmentRealisationResult" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="CancelAppointmentRealisation">
<s:complexType>
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="version" type="s:int"/>
<s:element minOccurs="0" maxOccurs="1" name="request" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="CancelAppointmentRealisationResponse">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="CancelAppointmentRealisationResult" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="GetReferralChanges">
<s:complexType>
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="version" type="s:int"/>
<s:element minOccurs="0" maxOccurs="1" name="request" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="GetReferralChangesResponse">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="GetReferralChangesResult" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="GetGuidelineForProcedure">
<s:complexType>
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="version" type="s:int"/>
<s:element minOccurs="0" maxOccurs="1" name="request" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="GetGuidelineForProcedureResponse">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="GetGuidelineForProcedureResult" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="CancelAdmission">
<s:complexType>
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="version" type="s:int"/>
<s:element minOccurs="0" maxOccurs="1" name="request" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="CancelAdmissionResponse">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="CancelAdmissionResult" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="SendMessage">
<s:complexType>
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="version" type="s:int"/>
<s:element minOccurs="0" maxOccurs="1" name="request" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="SendMessageResponse">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="SendMessageResult" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="GetFreeSlotForProcedureCOS">
<s:complexType>
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="version" type="s:int"/>
<s:element minOccurs="0" maxOccurs="1" name="request" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="GetFreeSlotForProcedureCOSResponse">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="GetFreeSlotForProcedureCOSResult" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="CreateAppointments">
<s:complexType>
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="version" type="s:int"/>
<s:element minOccurs="0" maxOccurs="1" name="request" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="CreateAppointmentsResponse">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="CreateAppointmentsResult" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="UpdateAppointments">
<s:complexType>
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="version" type="s:int"/>
<s:element minOccurs="0" maxOccurs="1" name="request" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="UpdateAppointmentsResponse">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="UpdateAppointmentsResult" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="CancelAppointments">
<s:complexType>
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="version" type="s:int"/>
<s:element minOccurs="0" maxOccurs="1" name="request" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="CancelAppointmentsResponse">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="CancelAppointmentsResult" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="CreateReferralAttachment">
<s:complexType>
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="version" type="s:int"/>
<s:element minOccurs="0" maxOccurs="1" name="request" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="CreateReferralAttachmentResponse">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="CreateReferralAttachmentResult" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="GetReferral">
<s:complexType>
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="version" type="s:int"/>
<s:element minOccurs="0" maxOccurs="1" name="request" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="GetReferralResponse">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="GetReferralResult" type="s:string"/>
<s:element minOccurs="0" maxOccurs="1" name="referralXml" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="GetReferralList">
<s:complexType>
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="version" type="s:int"/>
<s:element minOccurs="0" maxOccurs="1" name="request" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="GetReferralListResponse">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="GetReferralListResult" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="GetReferralPdf">
<s:complexType>
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="version" type="s:int"/>
<s:element minOccurs="0" maxOccurs="1" name="request" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="GetReferralPdfResponse">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="GetReferralPdfResult" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="GetAppointmentPDF">
<s:complexType>
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="version" type="s:int"/>
<s:element minOccurs="0" maxOccurs="1" name="request" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="GetAppointmentPDFResponse">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="GetAppointmentPDFResult" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="GetNewReferralId">
<s:complexType>
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="version" type="s:int"/>
<s:element minOccurs="0" maxOccurs="1" name="request" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="GetNewReferralIdResponse">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="GetNewReferralIdResult" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="SubmitCrossborderSlot">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="request" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="SubmitCrossborderSlotResponse">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="SubmitCrossborderSlotResult" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="GetReferralTimeline">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="request" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="GetReferralTimelineResponse">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="GetReferralTimelineResult" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="SubmitReferral">
<s:complexType>
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="version" type="s:int"/>
<s:element minOccurs="0" maxOccurs="1" name="request" type="s:string"/>
<s:element minOccurs="0" maxOccurs="1" name="referral" type="s:string"/>
<s:element minOccurs="0" maxOccurs="1" name="signature" type="s:base64Binary"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="SubmitReferralResponse">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="SubmitReferralResult" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="CreateAdmission">
<s:complexType>
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="version" type="s:int"/>
<s:element minOccurs="0" maxOccurs="1" name="request" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="CreateAdmissionResponse">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="CreateAdmissionResult" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="GetReferralAttachment">
<s:complexType>
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="version" type="s:int"/>
<s:element minOccurs="0" maxOccurs="1" name="request" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="GetReferralAttachmentResponse">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="GetReferralAttachmentResult" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="GetReferralAttachmentList">
<s:complexType>
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="version" type="s:int"/>
<s:element minOccurs="0" maxOccurs="1" name="request" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="GetReferralAttachmentListResponse">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="GetReferralAttachmentListResult" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="UpdateReferralAttachment">
<s:complexType>
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="version" type="s:int"/>
<s:element minOccurs="0" maxOccurs="1" name="request" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="UpdateReferralAttachmentResponse">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="UpdateReferralAttachmentResult" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="DeleteReferralAttachment">
<s:complexType>
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="version" type="s:int"/>
<s:element minOccurs="0" maxOccurs="1" name="request" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="DeleteReferralAttachmentResponse">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="DeleteReferralAttachmentResult" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="GetAppointment">
<s:complexType>
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="version" type="s:int"/>
<s:element minOccurs="0" maxOccurs="1" name="request" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="GetAppointmentResponse">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="GetAppointmentResult" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="GetAppointmentsForPatient">
<s:complexType>
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="version" type="s:int"/>
<s:element minOccurs="0" maxOccurs="1" name="request" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="GetAppointmentsForPatientResponse">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="GetAppointmentsForPatientResult" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="GetPrereservationForProcedureCOS">
<s:complexType>
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="version" type="s:int"/>
<s:element minOccurs="0" maxOccurs="1" name="request" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="GetPrereservationForProcedureCOSResponse">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="GetPrereservationForProcedureCOSResult" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="BookReservationCOS">
<s:complexType>
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="version" type="s:int"/>
<s:element minOccurs="0" maxOccurs="1" name="request" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="BookReservationCOSResponse">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="BookReservationCOSResult" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="CancelReservationCOS">
<s:complexType>
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="version" type="s:int"/>
<s:element minOccurs="0" maxOccurs="1" name="request" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="CancelReservationCOSResponse">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="CancelReservationCOSResult" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="CreateTask">
<s:complexType>
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="version" type="s:int"/>
<s:element minOccurs="0" maxOccurs="1" name="request" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="CreateTaskResponse">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="CreateTaskResult" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="CloseTask">
<s:complexType>
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="version" type="s:int"/>
<s:element minOccurs="0" maxOccurs="1" name="request" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="CloseTaskResponse">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="CloseTaskResult" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="GetTasksList">
<s:complexType>
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="version" type="s:int"/>
<s:element minOccurs="0" maxOccurs="1" name="request" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="GetTasksListResponse">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="GetTasksListResult" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="UpdateUrgencyTypeCode">
<s:complexType>
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="version" type="s:int"/>
<s:element minOccurs="0" maxOccurs="1" name="request" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="UpdateUrgencyTypeCodeResponse">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="UpdateUrgencyTypeCodeResult" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="UpdatePatientContact">
<s:complexType>
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="version" type="s:int"/>
<s:element minOccurs="0" maxOccurs="1" name="request" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="UpdatePatientContactResponse">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="UpdatePatientContactResult" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="UpdateReferralValidity">
<s:complexType>
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="version" type="s:int"/>
<s:element minOccurs="0" maxOccurs="1" name="request" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="UpdateReferralValidityResponse">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="UpdateReferralValidityResult" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="GetAppointmentsForReordering">
<s:complexType>
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="version" type="s:int"/>
<s:element minOccurs="0" maxOccurs="1" name="request" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="GetAppointmentsForReorderingResponse">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="GetAppointmentsForReorderingResult" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="ReferralTerminationWarning">
<s:complexType>
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="version" type="s:int"/>
<s:element minOccurs="0" maxOccurs="1" name="request" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="ReferralTerminationWarningResponse">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="ReferralTerminationWarningResult" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="ReferralTermination">
<s:complexType>
<s:sequence>
<s:element minOccurs="1" maxOccurs="1" name="version" type="s:int"/>
<s:element minOccurs="0" maxOccurs="1" name="request" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
<s:element name="ReferralTerminationResponse">
<s:complexType>
<s:sequence>
<s:element minOccurs="0" maxOccurs="1" name="ReferralTerminationResult" type="s:string"/>
</s:sequence>
</s:complexType>
</s:element>
</s:schema>
</wsdl:types>
<wsdl:message name="RegisterConcessionerSoapIn">
<wsdl:part name="parameters" element="tns:RegisterConcessioner"/>
</wsdl:message>
<wsdl:message name="RegisterConcessionerSoapOut">
<wsdl:part name="parameters" element="tns:RegisterConcessionerResponse"/>
</wsdl:message>
<wsdl:message name="RegisterProceduresForConcessionerSoapIn">
<wsdl:part name="parameters" element="tns:RegisterProceduresForConcessioner"/>
</wsdl:message>
<wsdl:message name="RegisterProceduresForConcessionerSoapOut">
<wsdl:part name="parameters" element="tns:RegisterProceduresForConcessionerResponse"/>
</wsdl:message>
<wsdl:message name="GetAEUCandidatesSoapIn">
<wsdl:part name="parameters" element="tns:GetAEUCandidates"/>
</wsdl:message>
<wsdl:message name="GetAEUCandidatesSoapOut">
<wsdl:part name="parameters" element="tns:GetAEUCandidatesResponse"/>
</wsdl:message>
<wsdl:message name="GetAEUCandidatesSecurityToken">
<wsdl:part name="SecurityToken" element="tns:SecurityToken"/>
</wsdl:message>
<wsdl:message name="AppointmentRealisationSoapIn">
<wsdl:part name="parameters" element="tns:AppointmentRealisation"/>
</wsdl:message>
<wsdl:message name="AppointmentRealisationSoapOut">
<wsdl:part name="parameters" element="tns:AppointmentRealisationResponse"/>
</wsdl:message>
<wsdl:message name="AppointmentRealisationSecurityToken">
<wsdl:part name="SecurityToken" element="tns:SecurityToken"/>
</wsdl:message>
<wsdl:message name="CancelAppointmentRealisationSoapIn">
<wsdl:part name="parameters" element="tns:CancelAppointmentRealisation"/>
</wsdl:message>
<wsdl:message name="CancelAppointmentRealisationSoapOut">
<wsdl:part name="parameters" element="tns:CancelAppointmentRealisationResponse"/>
</wsdl:message>
<wsdl:message name="CancelAppointmentRealisationSecurityToken">
<wsdl:part name="SecurityToken" element="tns:SecurityToken"/>
</wsdl:message>
<wsdl:message name="GetReferralChangesSoapIn">
<wsdl:part name="parameters" element="tns:GetReferralChanges"/>
</wsdl:message>
<wsdl:message name="GetReferralChangesSoapOut">
<wsdl:part name="parameters" element="tns:GetReferralChangesResponse"/>
</wsdl:message>
<wsdl:message name="GetReferralChangesSecurityToken">
<wsdl:part name="SecurityToken" element="tns:SecurityToken"/>
</wsdl:message>
<wsdl:message name="GetGuidelineForProcedureSoapIn">
<wsdl:part name="parameters" element="tns:GetGuidelineForProcedure"/>
</wsdl:message>
<wsdl:message name="GetGuidelineForProcedureSoapOut">
<wsdl:part name="parameters" element="tns:GetGuidelineForProcedureResponse"/>
</wsdl:message>
<wsdl:message name="GetGuidelineForProcedureSecurityToken">
<wsdl:part name="SecurityToken" element="tns:SecurityToken"/>
</wsdl:message>
<wsdl:message name="CancelAdmissionSoapIn">
<wsdl:part name="parameters" element="tns:CancelAdmission"/>
</wsdl:message>
<wsdl:message name="CancelAdmissionSoapOut">
<wsdl:part name="parameters" element="tns:CancelAdmissionResponse"/>
</wsdl:message>
<wsdl:message name="CancelAdmissionSecurityToken">
<wsdl:part name="SecurityToken" element="tns:SecurityToken"/>
</wsdl:message>
<wsdl:message name="SendMessageSoapIn">
<wsdl:part name="parameters" element="tns:SendMessage"/>
</wsdl:message>
<wsdl:message name="SendMessageSoapOut">
<wsdl:part name="parameters" element="tns:SendMessageResponse"/>
</wsdl:message>
<wsdl:message name="SendMessageSecurityToken">
<wsdl:part name="SecurityToken" element="tns:SecurityToken"/>
</wsdl:message>
<wsdl:message name="GetFreeSlotForProcedureCOSSoapIn">
<wsdl:part name="parameters" element="tns:GetFreeSlotForProcedureCOS"/>
</wsdl:message>
<wsdl:message name="GetFreeSlotForProcedureCOSSoapOut">
<wsdl:part name="parameters" element="tns:GetFreeSlotForProcedureCOSResponse"/>
</wsdl:message>
<wsdl:message name="GetFreeSlotForProcedureCOSSecurityToken">
<wsdl:part name="SecurityToken" element="tns:SecurityToken"/>
</wsdl:message>
<wsdl:message name="CreateAppointmentsSoapIn">
<wsdl:part name="parameters" element="tns:CreateAppointments"/>
</wsdl:message>
<wsdl:message name="CreateAppointmentsSoapOut">
<wsdl:part name="parameters" element="tns:CreateAppointmentsResponse"/>
</wsdl:message>
<wsdl:message name="CreateAppointmentsSecurityToken">
<wsdl:part name="SecurityToken" element="tns:SecurityToken"/>
</wsdl:message>
<wsdl:message name="UpdateAppointmentsSoapIn">
<wsdl:part name="parameters" element="tns:UpdateAppointments"/>
</wsdl:message>
<wsdl:message name="UpdateAppointmentsSoapOut">
<wsdl:part name="parameters" element="tns:UpdateAppointmentsResponse"/>
</wsdl:message>
<wsdl:message name="UpdateAppointmentsSecurityToken">
<wsdl:part name="SecurityToken" element="tns:SecurityToken"/>
</wsdl:message>
<wsdl:message name="CancelAppointmentsSoapIn">
<wsdl:part name="parameters" element="tns:CancelAppointments"/>
</wsdl:message>
<wsdl:message name="CancelAppointmentsSoapOut">
<wsdl:part name="parameters" element="tns:CancelAppointmentsResponse"/>
</wsdl:message>
<wsdl:message name="CancelAppointmentsSecurityToken">
<wsdl:part name="SecurityToken" element="tns:SecurityToken"/>
</wsdl:message>
<wsdl:message name="CreateReferralAttachmentSoapIn">
<wsdl:part name="parameters" element="tns:CreateReferralAttachment"/>
</wsdl:message>
<wsdl:message name="CreateReferralAttachmentSoapOut">
<wsdl:part name="parameters" element="tns:CreateReferralAttachmentResponse"/>
</wsdl:message>
<wsdl:message name="CreateReferralAttachmentSecurityToken">
<wsdl:part name="SecurityToken" element="tns:SecurityToken"/>
</wsdl:message>
<wsdl:message name="GetReferralSoapIn">
<wsdl:part name="parameters" element="tns:GetReferral"/>
</wsdl:message>
<wsdl:message name="GetReferralSoapOut">
<wsdl:part name="parameters" element="tns:GetReferralResponse"/>
</wsdl:message>
<wsdl:message name="GetReferralSecurityToken">
<wsdl:part name="SecurityToken" element="tns:SecurityToken"/>
</wsdl:message>
<wsdl:message name="GetReferralListSoapIn">
<wsdl:part name="parameters" element="tns:GetReferralList"/>
</wsdl:message>
<wsdl:message name="GetReferralListSoapOut">
<wsdl:part name="parameters" element="tns:GetReferralListResponse"/>
</wsdl:message>
<wsdl:message name="GetReferralListSecurityToken">
<wsdl:part name="SecurityToken" element="tns:SecurityToken"/>
</wsdl:message>
<wsdl:message name="GetReferralPdfSoapIn">
<wsdl:part name="parameters" element="tns:GetReferralPdf"/>
</wsdl:message>
<wsdl:message name="GetReferralPdfSoapOut">
<wsdl:part name="parameters" element="tns:GetReferralPdfResponse"/>
</wsdl:message>
<wsdl:message name="GetReferralPdfSecurityToken">
<wsdl:part name="SecurityToken" element="tns:SecurityToken"/>
</wsdl:message>
<wsdl:message name="GetAppointmentPDFSoapIn">
<wsdl:part name="parameters" element="tns:GetAppointmentPDF"/>
</wsdl:message>
<wsdl:message name="GetAppointmentPDFSoapOut">
<wsdl:part name="parameters" element="tns:GetAppointmentPDFResponse"/>
</wsdl:message>
<wsdl:message name="GetAppointmentPDFSecurityToken">
<wsdl:part name="SecurityToken" element="tns:SecurityToken"/>
</wsdl:message>
<wsdl:message name="GetNewReferralIdSoapIn">
<wsdl:part name="parameters" element="tns:GetNewReferralId"/>
</wsdl:message>
<wsdl:message name="GetNewReferralIdSoapOut">
<wsdl:part name="parameters" element="tns:GetNewReferralIdResponse"/>
</wsdl:message>
<wsdl:message name="GetNewReferralIdSecurityToken">
<wsdl:part name="SecurityToken" element="tns:SecurityToken"/>
</wsdl:message>
<wsdl:message name="SubmitCrossborderSlotSoapIn">
<wsdl:part name="parameters" element="tns:SubmitCrossborderSlot"/>
</wsdl:message>
<wsdl:message name="SubmitCrossborderSlotSoapOut">
<wsdl:part name="parameters" element="tns:SubmitCrossborderSlotResponse"/>
</wsdl:message>
<wsdl:message name="SubmitCrossborderSlotSecurityToken">
<wsdl:part name="SecurityToken" element="tns:SecurityToken"/>
</wsdl:message>
<wsdl:message name="GetReferralTimelineSoapIn">
<wsdl:part name="parameters" element="tns:GetReferralTimeline"/>
</wsdl:message>
<wsdl:message name="GetReferralTimelineSoapOut">
<wsdl:part name="parameters" element="tns:GetReferralTimelineResponse"/>
</wsdl:message>
<wsdl:message name="GetReferralTimelineSecurityToken">
<wsdl:part name="SecurityToken" element="tns:SecurityToken"/>
</wsdl:message>
<wsdl:message name="SubmitReferralSoapIn">
<wsdl:part name="parameters" element="tns:SubmitReferral"/>
</wsdl:message>
<wsdl:message name="SubmitReferralSoapOut">
<wsdl:part name="parameters" element="tns:SubmitReferralResponse"/>
</wsdl:message>
<wsdl:message name="SubmitReferralSecurityToken">
<wsdl:part name="SecurityToken" element="tns:SecurityToken"/>
</wsdl:message>
<wsdl:message name="CreateAdmissionSoapIn">
<wsdl:part name="parameters" element="tns:CreateAdmission"/>
</wsdl:message>
<wsdl:message name="CreateAdmissionSoapOut">
<wsdl:part name="parameters" element="tns:CreateAdmissionResponse"/>
</wsdl:message>
<wsdl:message name="CreateAdmissionSecurityToken">
<wsdl:part name="SecurityToken" element="tns:SecurityToken"/>
</wsdl:message>
<wsdl:message name="GetReferralAttachmentSoapIn">
<wsdl:part name="parameters" element="tns:GetReferralAttachment"/>
</wsdl:message>
<wsdl:message name="GetReferralAttachmentSoapOut">
<wsdl:part name="parameters" element="tns:GetReferralAttachmentResponse"/>
</wsdl:message>
<wsdl:message name="GetReferralAttachmentSecurityToken">
<wsdl:part name="SecurityToken" element="tns:SecurityToken"/>
</wsdl:message>
<wsdl:message name="GetReferralAttachmentListSoapIn">
<wsdl:part name="parameters" element="tns:GetReferralAttachmentList"/>
</wsdl:message>
<wsdl:message name="GetReferralAttachmentListSoapOut">
<wsdl:part name="parameters" element="tns:GetReferralAttachmentListResponse"/>
</wsdl:message>
<wsdl:message name="GetReferralAttachmentListSecurityToken">
<wsdl:part name="SecurityToken" element="tns:SecurityToken"/>
</wsdl:message>
<wsdl:message name="UpdateReferralAttachmentSoapIn">
<wsdl:part name="parameters" element="tns:UpdateReferralAttachment"/>
</wsdl:message>
<wsdl:message name="UpdateReferralAttachmentSoapOut">
<wsdl:part name="parameters" element="tns:UpdateReferralAttachmentResponse"/>
</wsdl:message>
<wsdl:message name="UpdateReferralAttachmentSecurityToken">
<wsdl:part name="SecurityToken" element="tns:SecurityToken"/>
</wsdl:message>
<wsdl:message name="DeleteReferralAttachmentSoapIn">
<wsdl:part name="parameters" element="tns:DeleteReferralAttachment"/>
</wsdl:message>
<wsdl:message name="DeleteReferralAttachmentSoapOut">
<wsdl:part name="parameters" element="tns:DeleteReferralAttachmentResponse"/>
</wsdl:message>
<wsdl:message name="DeleteReferralAttachmentSecurityToken">
<wsdl:part name="SecurityToken" element="tns:SecurityToken"/>
</wsdl:message>
<wsdl:message name="GetAppointmentSoapIn">
<wsdl:part name="parameters" element="tns:GetAppointment"/>
</wsdl:message>
<wsdl:message name="GetAppointmentSoapOut">
<wsdl:part name="parameters" element="tns:GetAppointmentResponse"/>
</wsdl:message>
<wsdl:message name="GetAppointmentSecurityToken">
<wsdl:part name="SecurityToken" element="tns:SecurityToken"/>
</wsdl:message>
<wsdl:message name="GetAppointmentsForPatientSoapIn">
<wsdl:part name="parameters" element="tns:GetAppointmentsForPatient"/>
</wsdl:message>
<wsdl:message name="GetAppointmentsForPatientSoapOut">
<wsdl:part name="parameters" element="tns:GetAppointmentsForPatientResponse"/>
</wsdl:message>
<wsdl:message name="GetAppointmentsForPatientSecurityToken">
<wsdl:part name="SecurityToken" element="tns:SecurityToken"/>
</wsdl:message>
<wsdl:message name="GetPrereservationForProcedureCOSSoapIn">
<wsdl:part name="parameters" element="tns:GetPrereservationForProcedureCOS"/>
</wsdl:message>
<wsdl:message name="GetPrereservationForProcedureCOSSoapOut">
<wsdl:part name="parameters" element="tns:GetPrereservationForProcedureCOSResponse"/>
</wsdl:message>
<wsdl:message name="GetPrereservationForProcedureCOSSecurityToken">
<wsdl:part name="SecurityToken" element="tns:SecurityToken"/>
</wsdl:message>
<wsdl:message name="BookReservationCOSSoapIn">
<wsdl:part name="parameters" element="tns:BookReservationCOS"/>
</wsdl:message>
<wsdl:message name="BookReservationCOSSoapOut">
<wsdl:part name="parameters" element="tns:BookReservationCOSResponse"/>
</wsdl:message>
<wsdl:message name="BookReservationCOSSecurityToken">
<wsdl:part name="SecurityToken" element="tns:SecurityToken"/>
</wsdl:message>
<wsdl:message name="CancelReservationCOSSoapIn">
<wsdl:part name="parameters" element="tns:CancelReservationCOS"/>
</wsdl:message>
<wsdl:message name="CancelReservationCOSSoapOut">
<wsdl:part name="parameters" element="tns:CancelReservationCOSResponse"/>
</wsdl:message>
<wsdl:message name="CancelReservationCOSSecurityToken">
<wsdl:part name="SecurityToken" element="tns:SecurityToken"/>
</wsdl:message>
<wsdl:message name="CreateTaskSoapIn">
<wsdl:part name="parameters" element="tns:CreateTask"/>
</wsdl:message>
<wsdl:message name="CreateTaskSoapOut">
<wsdl:part name="parameters" element="tns:CreateTaskResponse"/>
</wsdl:message>
<wsdl:message name="CreateTaskSecurityToken">
<wsdl:part name="SecurityToken" element="tns:SecurityToken"/>
</wsdl:message>
<wsdl:message name="CloseTaskSoapIn">
<wsdl:part name="parameters" element="tns:CloseTask"/>
</wsdl:message>
<wsdl:message name="CloseTaskSoapOut">
<wsdl:part name="parameters" element="tns:CloseTaskResponse"/>
</wsdl:message>
<wsdl:message name="CloseTaskSecurityToken">
<wsdl:part name="SecurityToken" element="tns:SecurityToken"/>
</wsdl:message>
<wsdl:message name="GetTasksListSoapIn">
<wsdl:part name="parameters" element="tns:GetTasksList"/>
</wsdl:message>
<wsdl:message name="GetTasksListSoapOut">
<wsdl:part name="parameters" element="tns:GetTasksListResponse"/>
</wsdl:message>
<wsdl:message name="GetTasksListSecurityToken">
<wsdl:part name="SecurityToken" element="tns:SecurityToken"/>
</wsdl:message>
<wsdl:message name="UpdateUrgencyTypeCodeSoapIn">
<wsdl:part name="parameters" element="tns:UpdateUrgencyTypeCode"/>
</wsdl:message>
<wsdl:message name="UpdateUrgencyTypeCodeSoapOut">
<wsdl:part name="parameters" element="tns:UpdateUrgencyTypeCodeResponse"/>
</wsdl:message>
<wsdl:message name="UpdateUrgencyTypeCodeSecurityToken">
<wsdl:part name="SecurityToken" element="tns:SecurityToken"/>
</wsdl:message>
<wsdl:message name="UpdatePatientContactSoapIn">
<wsdl:part name="parameters" element="tns:UpdatePatientContact"/>
</wsdl:message>
<wsdl:message name="UpdatePatientContactSoapOut">
<wsdl:part name="parameters" element="tns:UpdatePatientContactResponse"/>
</wsdl:message>
<wsdl:message name="UpdatePatientContactSecurityToken">
<wsdl:part name="SecurityToken" element="tns:SecurityToken"/>
</wsdl:message>
<wsdl:message name="UpdateReferralValiditySoapIn">
<wsdl:part name="parameters" element="tns:UpdateReferralValidity"/>
</wsdl:message>
<wsdl:message name="UpdateReferralValiditySoapOut">
<wsdl:part name="parameters" element="tns:UpdateReferralValidityResponse"/>
</wsdl:message>
<wsdl:message name="UpdateReferralValiditySecurityToken">
<wsdl:part name="SecurityToken" element="tns:SecurityToken"/>
</wsdl:message>
<wsdl:message name="GetAppointmentsForReorderingSoapIn">
<wsdl:part name="parameters" element="tns:GetAppointmentsForReordering"/>
</wsdl:message>
<wsdl:message name="GetAppointmentsForReorderingSoapOut">
<wsdl:part name="parameters" element="tns:GetAppointmentsForReorderingResponse"/>
</wsdl:message>
<wsdl:message name="GetAppointmentsForReorderingSecurityToken">
<wsdl:part name="SecurityToken" element="tns:SecurityToken"/>
</wsdl:message>
<wsdl:message name="ReferralTerminationWarningSoapIn">
<wsdl:part name="parameters" element="tns:ReferralTerminationWarning"/>
</wsdl:message>
<wsdl:message name="ReferralTerminationWarningSoapOut">
<wsdl:part name="parameters" element="tns:ReferralTerminationWarningResponse"/>
</wsdl:message>
<wsdl:message name="ReferralTerminationWarningSecurityToken">
<wsdl:part name="SecurityToken" element="tns:SecurityToken"/>
</wsdl:message>
<wsdl:message name="ReferralTerminationSoapIn">
<wsdl:part name="parameters" element="tns:ReferralTermination"/>
</wsdl:message>
<wsdl:message name="ReferralTerminationSoapOut">
<wsdl:part name="parameters" element="tns:ReferralTerminationResponse"/>
</wsdl:message>
<wsdl:message name="ReferralTerminationSecurityToken">
<wsdl:part name="SecurityToken" element="tns:SecurityToken"/>
</wsdl:message>
<wsdl:portType name="CosWebServicePublicV3Soap">
<wsdl:operation name="RegisterConcessioner">
<wsdl:input message="tns:RegisterConcessionerSoapIn"/>
<wsdl:output message="tns:RegisterConcessionerSoapOut"/>
</wsdl:operation>
<wsdl:operation name="RegisterProceduresForConcessioner">
<wsdl:input message="tns:RegisterProceduresForConcessionerSoapIn"/>
<wsdl:output message="tns:RegisterProceduresForConcessionerSoapOut"/>
</wsdl:operation>
<wsdl:operation name="GetAEUCandidates">
<wsdl:input message="tns:GetAEUCandidatesSoapIn"/>
<wsdl:output message="tns:GetAEUCandidatesSoapOut"/>
</wsdl:operation>
<wsdl:operation name="AppointmentRealisation">
<wsdl:input message="tns:AppointmentRealisationSoapIn"/>
<wsdl:output message="tns:AppointmentRealisationSoapOut"/>
</wsdl:operation>
<wsdl:operation name="CancelAppointmentRealisation">
<wsdl:input message="tns:CancelAppointmentRealisationSoapIn"/>
<wsdl:output message="tns:CancelAppointmentRealisationSoapOut"/>
</wsdl:operation>
<wsdl:operation name="GetReferralChanges">
<wsdl:input message="tns:GetReferralChangesSoapIn"/>
<wsdl:output message="tns:GetReferralChangesSoapOut"/>
</wsdl:operation>
<wsdl:operation name="GetGuidelineForProcedure">
<wsdl:input message="tns:GetGuidelineForProcedureSoapIn"/>
<wsdl:output message="tns:GetGuidelineForProcedureSoapOut"/>
</wsdl:operation>
<wsdl:operation name="CancelAdmission">
<wsdl:input message="tns:CancelAdmissionSoapIn"/>
<wsdl:output message="tns:CancelAdmissionSoapOut"/>
</wsdl:operation>
<wsdl:operation name="SendMessage">
<wsdl:input message="tns:SendMessageSoapIn"/>
<wsdl:output message="tns:SendMessageSoapOut"/>
</wsdl:operation>
<wsdl:operation name="GetFreeSlotForProcedureCOS">
<wsdl:input message="tns:GetFreeSlotForProcedureCOSSoapIn"/>
<wsdl:output message="tns:GetFreeSlotForProcedureCOSSoapOut"/>
</wsdl:operation>
<wsdl:operation name="CreateAppointments">
<wsdl:input message="tns:CreateAppointmentsSoapIn"/>
<wsdl:output message="tns:CreateAppointmentsSoapOut"/>
</wsdl:operation>
<wsdl:operation name="UpdateAppointments">
<wsdl:input message="tns:UpdateAppointmentsSoapIn"/>
<wsdl:output message="tns:UpdateAppointmentsSoapOut"/>
</wsdl:operation>
<wsdl:operation name="CancelAppointments">
<wsdl:input message="tns:CancelAppointmentsSoapIn"/>
<wsdl:output message="tns:CancelAppointmentsSoapOut"/>
</wsdl:operation>
<wsdl:operation name="CreateReferralAttachment">
<wsdl:input message="tns:CreateReferralAttachmentSoapIn"/>
<wsdl:output message="tns:CreateReferralAttachmentSoapOut"/>
</wsdl:operation>
<wsdl:operation name="GetReferral">
<wsdl:input message="tns:GetReferralSoapIn"/>
<wsdl:output message="tns:GetReferralSoapOut"/>
</wsdl:operation>
<wsdl:operation name="GetReferralList">
<wsdl:input message="tns:GetReferralListSoapIn"/>
<wsdl:output message="tns:GetReferralListSoapOut"/>
</wsdl:operation>
<wsdl:operation name="GetReferralPdf">
<wsdl:input message="tns:GetReferralPdfSoapIn"/>
<wsdl:output message="tns:GetReferralPdfSoapOut"/>
</wsdl:operation>
<wsdl:operation name="GetAppointmentPDF">
<wsdl:input message="tns:GetAppointmentPDFSoapIn"/>
<wsdl:output message="tns:GetAppointmentPDFSoapOut"/>
</wsdl:operation>
<wsdl:operation name="GetNewReferralId">
<wsdl:input message="tns:GetNewReferralIdSoapIn"/>
<wsdl:output message="tns:GetNewReferralIdSoapOut"/>
</wsdl:operation>
<wsdl:operation name="SubmitCrossborderSlot">
<wsdl:input message="tns:SubmitCrossborderSlotSoapIn"/>
<wsdl:output message="tns:SubmitCrossborderSlotSoapOut"/>
</wsdl:operation>
<wsdl:operation name="GetReferralTimeline">
<wsdl:input message="tns:GetReferralTimelineSoapIn"/>
<wsdl:output message="tns:GetReferralTimelineSoapOut"/>
</wsdl:operation>
<wsdl:operation name="SubmitReferral">
<wsdl:input message="tns:SubmitReferralSoapIn"/>
<wsdl:output message="tns:SubmitReferralSoapOut"/>
</wsdl:operation>
<wsdl:operation name="CreateAdmission">
<wsdl:input message="tns:CreateAdmissionSoapIn"/>
<wsdl:output message="tns:CreateAdmissionSoapOut"/>
</wsdl:operation>
<wsdl:operation name="GetReferralAttachment">
<wsdl:input message="tns:GetReferralAttachmentSoapIn"/>
<wsdl:output message="tns:GetReferralAttachmentSoapOut"/>
</wsdl:operation>
<wsdl:operation name="GetReferralAttachmentList">
<wsdl:input message="tns:GetReferralAttachmentListSoapIn"/>
<wsdl:output message="tns:GetReferralAttachmentListSoapOut"/>
</wsdl:operation>
<wsdl:operation name="UpdateReferralAttachment">
<wsdl:input message="tns:UpdateReferralAttachmentSoapIn"/>
<wsdl:output message="tns:UpdateReferralAttachmentSoapOut"/>
</wsdl:operation>
<wsdl:operation name="DeleteReferralAttachment">
<wsdl:input message="tns:DeleteReferralAttachmentSoapIn"/>
<wsdl:output message="tns:DeleteReferralAttachmentSoapOut"/>
</wsdl:operation>
<wsdl:operation name="GetAppointment">
<wsdl:input message="tns:GetAppointmentSoapIn"/>
<wsdl:output message="tns:GetAppointmentSoapOut"/>
</wsdl:operation>
<wsdl:operation name="GetAppointmentsForPatient">
<wsdl:input message="tns:GetAppointmentsForPatientSoapIn"/>
<wsdl:output message="tns:GetAppointmentsForPatientSoapOut"/>
</wsdl:operation>
<wsdl:operation name="GetPrereservationForProcedureCOS">
<wsdl:input message="tns:GetPrereservationForProcedureCOSSoapIn"/>
<wsdl:output message="tns:GetPrereservationForProcedureCOSSoapOut"/>
</wsdl:operation>
<wsdl:operation name="BookReservationCOS">
<wsdl:input message="tns:BookReservationCOSSoapIn"/>
<wsdl:output message="tns:BookReservationCOSSoapOut"/>
</wsdl:operation>
<wsdl:operation name="CancelReservationCOS">
<wsdl:input message="tns:CancelReservationCOSSoapIn"/>
<wsdl:output message="tns:CancelReservationCOSSoapOut"/>
</wsdl:operation>
<wsdl:operation name="CreateTask">
<wsdl:input message="tns:CreateTaskSoapIn"/>
<wsdl:output message="tns:CreateTaskSoapOut"/>
</wsdl:operation>
<wsdl:operation name="CloseTask">
<wsdl:input message="tns:CloseTaskSoapIn"/>
<wsdl:output message="tns:CloseTaskSoapOut"/>
</wsdl:operation>
<wsdl:operation name="GetTasksList">
<wsdl:input message="tns:GetTasksListSoapIn"/>
<wsdl:output message="tns:GetTasksListSoapOut"/>
</wsdl:operation>
<wsdl:operation name="UpdateUrgencyTypeCode">
<wsdl:input message="tns:UpdateUrgencyTypeCodeSoapIn"/>
<wsdl:output message="tns:UpdateUrgencyTypeCodeSoapOut"/>
</wsdl:operation>
<wsdl:operation name="UpdatePatientContact">
<wsdl:input message="tns:UpdatePatientContactSoapIn"/>
<wsdl:output message="tns:UpdatePatientContactSoapOut"/>
</wsdl:operation>
<wsdl:operation name="UpdateReferralValidity">
<wsdl:input message="tns:UpdateReferralValiditySoapIn"/>
<wsdl:output message="tns:UpdateReferralValiditySoapOut"/>
</wsdl:operation>
<wsdl:operation name="GetAppointmentsForReordering">
<wsdl:input message="tns:GetAppointmentsForReorderingSoapIn"/>
<wsdl:output message="tns:GetAppointmentsForReorderingSoapOut"/>
</wsdl:operation>
<wsdl:operation name="ReferralTerminationWarning">
<wsdl:input message="tns:ReferralTerminationWarningSoapIn"/>
<wsdl:output message="tns:ReferralTerminationWarningSoapOut"/>
</wsdl:operation>
<wsdl:operation name="ReferralTermination">
<wsdl:input message="tns:ReferralTerminationSoapIn"/>
<wsdl:output message="tns:ReferralTerminationSoapOut"/>
</wsdl:operation>
</wsdl:portType>
<wsdl:binding name="CosWebServicePublicV3Soap" type="tns:CosWebServicePublicV3Soap">
<soap:binding transport="http://schemas.xmlsoap.org/soap/http"/>
<wsdl:operation name="RegisterConcessioner">
<soap:operation soapAction="http://IN2.Ordering.org/RegisterConcessioner" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="RegisterProceduresForConcessioner">
<soap:operation soapAction="http://IN2.Ordering.org/RegisterProceduresForConcessioner" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="GetAEUCandidates">
<soap:operation soapAction="http://IN2.Ordering.org/GetAEUCandidates" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
<soap:header message="tns:GetAEUCandidatesSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="AppointmentRealisation">
<soap:operation soapAction="http://IN2.Ordering.org/AppointmentRealisation" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
<soap:header message="tns:AppointmentRealisationSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="CancelAppointmentRealisation">
<soap:operation soapAction="http://IN2.Ordering.org/CancelAppointmentRealisation" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
<soap:header message="tns:CancelAppointmentRealisationSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="GetReferralChanges">
<soap:operation soapAction="http://IN2.Ordering.org/GetReferralChanges" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
<soap:header message="tns:GetReferralChangesSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="GetGuidelineForProcedure">
<soap:operation soapAction="http://IN2.Ordering.org/GetGuidelineForProcedure" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
<soap:header message="tns:GetGuidelineForProcedureSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="CancelAdmission">
<soap:operation soapAction="http://IN2.Ordering.org/CancelAdmission" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
<soap:header message="tns:CancelAdmissionSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="SendMessage">
<soap:operation soapAction="http://IN2.Ordering.org/SendMessage" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
<soap:header message="tns:SendMessageSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="GetFreeSlotForProcedureCOS">
<soap:operation soapAction="http://IN2.Ordering.org/GetFreeSlotForProcedureCOS" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
<soap:header message="tns:GetFreeSlotForProcedureCOSSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="CreateAppointments">
<soap:operation soapAction="http://IN2.Ordering.org/CreateAppointments" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
<soap:header message="tns:CreateAppointmentsSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="UpdateAppointments">
<soap:operation soapAction="http://IN2.Ordering.org/UpdateAppointments" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
<soap:header message="tns:UpdateAppointmentsSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="CancelAppointments">
<soap:operation soapAction="http://IN2.Ordering.org/CancelAppointments" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
<soap:header message="tns:CancelAppointmentsSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="CreateReferralAttachment">
<soap:operation soapAction="http://IN2.Ordering.org/CreateReferralAttachment" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
<soap:header message="tns:CreateReferralAttachmentSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="GetReferral">
<soap:operation soapAction="http://IN2.Ordering.org/GetReferral" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
<soap:header message="tns:GetReferralSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="GetReferralList">
<soap:operation soapAction="http://IN2.Ordering.org/GetReferralList" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
<soap:header message="tns:GetReferralListSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="GetReferralPdf">
<soap:operation soapAction="http://IN2.Ordering.org/GetReferralPdf" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
<soap:header message="tns:GetReferralPdfSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="GetAppointmentPDF">
<soap:operation soapAction="http://IN2.Ordering.org/GetAppointmentPDF" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
<soap:header message="tns:GetAppointmentPDFSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="GetNewReferralId">
<soap:operation soapAction="http://IN2.Ordering.org/GetNewReferralId" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
<soap:header message="tns:GetNewReferralIdSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="SubmitCrossborderSlot">
<soap:operation soapAction="http://IN2.Ordering.org/SubmitCrossborderSlot" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
<soap:header message="tns:SubmitCrossborderSlotSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="GetReferralTimeline">
<soap:operation soapAction="http://IN2.Ordering.org/GetReferralTimeline" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
<soap:header message="tns:GetReferralTimelineSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="SubmitReferral">
<soap:operation soapAction="http://IN2.Ordering.org/SubmitReferral" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
<soap:header message="tns:SubmitReferralSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="CreateAdmission">
<soap:operation soapAction="http://IN2.Ordering.org/CreateAdmission" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
<soap:header message="tns:CreateAdmissionSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="GetReferralAttachment">
<soap:operation soapAction="http://IN2.Ordering.org/GetReferralAttachment" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
<soap:header message="tns:GetReferralAttachmentSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="GetReferralAttachmentList">
<soap:operation soapAction="http://IN2.Ordering.org/GetReferralAttachmentList" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
<soap:header message="tns:GetReferralAttachmentListSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="UpdateReferralAttachment">
<soap:operation soapAction="http://IN2.Ordering.org/UpdateReferralAttachment" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
<soap:header message="tns:UpdateReferralAttachmentSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="DeleteReferralAttachment">
<soap:operation soapAction="http://IN2.Ordering.org/DeleteReferralAttachment" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
<soap:header message="tns:DeleteReferralAttachmentSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="GetAppointment">
<soap:operation soapAction="http://IN2.Ordering.org/GetAppointment" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
<soap:header message="tns:GetAppointmentSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="GetAppointmentsForPatient">
<soap:operation soapAction="http://IN2.Ordering.org/GetAppointmentsForPatient" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
<soap:header message="tns:GetAppointmentsForPatientSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="GetPrereservationForProcedureCOS">
<soap:operation soapAction="http://IN2.Ordering.org/GetPrereservationForProcedureCOS" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
<soap:header message="tns:GetPrereservationForProcedureCOSSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="BookReservationCOS">
<soap:operation soapAction="http://IN2.Ordering.org/BookReservationCOS" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
<soap:header message="tns:BookReservationCOSSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="CancelReservationCOS">
<soap:operation soapAction="http://IN2.Ordering.org/CancelReservationCOS" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
<soap:header message="tns:CancelReservationCOSSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="CreateTask">
<soap:operation soapAction="http://IN2.Ordering.org/CreateTask" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
<soap:header message="tns:CreateTaskSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="CloseTask">
<soap:operation soapAction="http://IN2.Ordering.org/CloseTask" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
<soap:header message="tns:CloseTaskSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="GetTasksList">
<soap:operation soapAction="http://IN2.Ordering.org/GetTasksList" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
<soap:header message="tns:GetTasksListSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="UpdateUrgencyTypeCode">
<soap:operation soapAction="http://IN2.Ordering.org/UpdateUrgencyTypeCode" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
<soap:header message="tns:UpdateUrgencyTypeCodeSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="UpdatePatientContact">
<soap:operation soapAction="http://IN2.Ordering.org/UpdatePatientContact" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
<soap:header message="tns:UpdatePatientContactSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="UpdateReferralValidity">
<soap:operation soapAction="http://IN2.Ordering.org/UpdateReferralValidity" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
<soap:header message="tns:UpdateReferralValiditySecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="GetAppointmentsForReordering">
<soap:operation soapAction="http://IN2.Ordering.org/GetAppointmentsForReordering" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
<soap:header message="tns:GetAppointmentsForReorderingSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="ReferralTerminationWarning">
<soap:operation soapAction="http://IN2.Ordering.org/ReferralTerminationWarning" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
<soap:header message="tns:ReferralTerminationWarningSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="ReferralTermination">
<soap:operation soapAction="http://IN2.Ordering.org/ReferralTermination" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
<soap:header message="tns:ReferralTerminationSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
</wsdl:binding>
<wsdl:binding name="CosWebServicePublicV3Soap12" type="tns:CosWebServicePublicV3Soap">
<soap12:binding transport="http://schemas.xmlsoap.org/soap/http"/>
<wsdl:operation name="RegisterConcessioner">
<soap12:operation soapAction="http://IN2.Ordering.org/RegisterConcessioner" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="RegisterProceduresForConcessioner">
<soap12:operation soapAction="http://IN2.Ordering.org/RegisterProceduresForConcessioner" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="GetAEUCandidates">
<soap12:operation soapAction="http://IN2.Ordering.org/GetAEUCandidates" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
<soap12:header message="tns:GetAEUCandidatesSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="AppointmentRealisation">
<soap12:operation soapAction="http://IN2.Ordering.org/AppointmentRealisation" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
<soap12:header message="tns:AppointmentRealisationSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="CancelAppointmentRealisation">
<soap12:operation soapAction="http://IN2.Ordering.org/CancelAppointmentRealisation" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
<soap12:header message="tns:CancelAppointmentRealisationSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="GetReferralChanges">
<soap12:operation soapAction="http://IN2.Ordering.org/GetReferralChanges" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
<soap12:header message="tns:GetReferralChangesSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="GetGuidelineForProcedure">
<soap12:operation soapAction="http://IN2.Ordering.org/GetGuidelineForProcedure" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
<soap12:header message="tns:GetGuidelineForProcedureSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="CancelAdmission">
<soap12:operation soapAction="http://IN2.Ordering.org/CancelAdmission" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
<soap12:header message="tns:CancelAdmissionSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="SendMessage">
<soap12:operation soapAction="http://IN2.Ordering.org/SendMessage" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
<soap12:header message="tns:SendMessageSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="GetFreeSlotForProcedureCOS">
<soap12:operation soapAction="http://IN2.Ordering.org/GetFreeSlotForProcedureCOS" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
<soap12:header message="tns:GetFreeSlotForProcedureCOSSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="CreateAppointments">
<soap12:operation soapAction="http://IN2.Ordering.org/CreateAppointments" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
<soap12:header message="tns:CreateAppointmentsSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="UpdateAppointments">
<soap12:operation soapAction="http://IN2.Ordering.org/UpdateAppointments" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
<soap12:header message="tns:UpdateAppointmentsSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="CancelAppointments">
<soap12:operation soapAction="http://IN2.Ordering.org/CancelAppointments" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
<soap12:header message="tns:CancelAppointmentsSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="CreateReferralAttachment">
<soap12:operation soapAction="http://IN2.Ordering.org/CreateReferralAttachment" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
<soap12:header message="tns:CreateReferralAttachmentSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="GetReferral">
<soap12:operation soapAction="http://IN2.Ordering.org/GetReferral" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
<soap12:header message="tns:GetReferralSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="GetReferralList">
<soap12:operation soapAction="http://IN2.Ordering.org/GetReferralList" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
<soap12:header message="tns:GetReferralListSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="GetReferralPdf">
<soap12:operation soapAction="http://IN2.Ordering.org/GetReferralPdf" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
<soap12:header message="tns:GetReferralPdfSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="GetAppointmentPDF">
<soap12:operation soapAction="http://IN2.Ordering.org/GetAppointmentPDF" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
<soap12:header message="tns:GetAppointmentPDFSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="GetNewReferralId">
<soap12:operation soapAction="http://IN2.Ordering.org/GetNewReferralId" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
<soap12:header message="tns:GetNewReferralIdSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="SubmitCrossborderSlot">
<soap12:operation soapAction="http://IN2.Ordering.org/SubmitCrossborderSlot" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
<soap12:header message="tns:SubmitCrossborderSlotSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="GetReferralTimeline">
<soap12:operation soapAction="http://IN2.Ordering.org/GetReferralTimeline" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
<soap12:header message="tns:GetReferralTimelineSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="SubmitReferral">
<soap12:operation soapAction="http://IN2.Ordering.org/SubmitReferral" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
<soap12:header message="tns:SubmitReferralSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="CreateAdmission">
<soap12:operation soapAction="http://IN2.Ordering.org/CreateAdmission" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
<soap12:header message="tns:CreateAdmissionSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="GetReferralAttachment">
<soap12:operation soapAction="http://IN2.Ordering.org/GetReferralAttachment" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
<soap12:header message="tns:GetReferralAttachmentSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="GetReferralAttachmentList">
<soap12:operation soapAction="http://IN2.Ordering.org/GetReferralAttachmentList" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
<soap12:header message="tns:GetReferralAttachmentListSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="UpdateReferralAttachment">
<soap12:operation soapAction="http://IN2.Ordering.org/UpdateReferralAttachment" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
<soap12:header message="tns:UpdateReferralAttachmentSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="DeleteReferralAttachment">
<soap12:operation soapAction="http://IN2.Ordering.org/DeleteReferralAttachment" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
<soap12:header message="tns:DeleteReferralAttachmentSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="GetAppointment">
<soap12:operation soapAction="http://IN2.Ordering.org/GetAppointment" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
<soap12:header message="tns:GetAppointmentSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="GetAppointmentsForPatient">
<soap12:operation soapAction="http://IN2.Ordering.org/GetAppointmentsForPatient" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
<soap12:header message="tns:GetAppointmentsForPatientSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="GetPrereservationForProcedureCOS">
<soap12:operation soapAction="http://IN2.Ordering.org/GetPrereservationForProcedureCOS" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
<soap12:header message="tns:GetPrereservationForProcedureCOSSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="BookReservationCOS">
<soap12:operation soapAction="http://IN2.Ordering.org/BookReservationCOS" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
<soap12:header message="tns:BookReservationCOSSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="CancelReservationCOS">
<soap12:operation soapAction="http://IN2.Ordering.org/CancelReservationCOS" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
<soap12:header message="tns:CancelReservationCOSSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="CreateTask">
<soap12:operation soapAction="http://IN2.Ordering.org/CreateTask" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
<soap12:header message="tns:CreateTaskSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="CloseTask">
<soap12:operation soapAction="http://IN2.Ordering.org/CloseTask" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
<soap12:header message="tns:CloseTaskSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="GetTasksList">
<soap12:operation soapAction="http://IN2.Ordering.org/GetTasksList" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
<soap12:header message="tns:GetTasksListSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="UpdateUrgencyTypeCode">
<soap12:operation soapAction="http://IN2.Ordering.org/UpdateUrgencyTypeCode" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
<soap12:header message="tns:UpdateUrgencyTypeCodeSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="UpdatePatientContact">
<soap12:operation soapAction="http://IN2.Ordering.org/UpdatePatientContact" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
<soap12:header message="tns:UpdatePatientContactSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="UpdateReferralValidity">
<soap12:operation soapAction="http://IN2.Ordering.org/UpdateReferralValidity" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
<soap12:header message="tns:UpdateReferralValiditySecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="GetAppointmentsForReordering">
<soap12:operation soapAction="http://IN2.Ordering.org/GetAppointmentsForReordering" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
<soap12:header message="tns:GetAppointmentsForReorderingSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="ReferralTerminationWarning">
<soap12:operation soapAction="http://IN2.Ordering.org/ReferralTerminationWarning" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
<soap12:header message="tns:ReferralTerminationWarningSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="ReferralTermination">
<soap12:operation soapAction="http://IN2.Ordering.org/ReferralTermination" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
<soap12:header message="tns:ReferralTerminationSecurityToken" part="SecurityToken" use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
</wsdl:binding>
<wsdl:service name="CosWebServicePublicV3">
<wsdl:port name="CosWebServicePublicV3Soap" binding="tns:CosWebServicePublicV3Soap">
<soap:address location="https://localhost:44342/CosWebServicePublicV3.asmx"/>
</wsdl:port>
<wsdl:port name="CosWebServicePublicV3Soap12" binding="tns:CosWebServicePublicV3Soap12">
<soap12:address location="https://localhost:44342/CosWebServicePublicV3.asmx"/>
</wsdl:port>
</wsdl:service>
</wsdl:definitions>
8. Changelog
07.07.2021
Updated: GetRealisationsForProcedureResposneHOS response message
- Element name changed:
AppointmentRealisation → AppointmentCancellation
- Field
AppointmentRealisations: added type="AppointmentRealisations"
- Field
AppointmentCancellations: added type="AppointmentCancellations"
06.09.2021 – v3.8
Updated: GetAppointmentsForProcedureResponseHOS response message
- In element
PatientAppointments, element PatientAppointment changed minOccurs from 1 to 0
Updated: LinkAppointmentsToNewReferralRequestHOS request message
- Added element:
MedicalFacilityCode
- Added element:
MedicalFacilitySpecificCode
14.09.2021 – v3.9
Updated: GetAppointmentResponse and GetAppointmentsForPatientResponse
MedicalFacilityPhone: mandatory changed to NO
MedicalFacilityEMail: mandatory changed to NO
07.10.2021 – v3.10
11.10.2021 – v3.11
13.10.2021 – v3.12
- BookReservationRequestCOS
MedicalFacilityCode type changed to BPIType
MedicalFacilitySpecificCode type changed to BPIspecificType
15.10.2021 – v3.13
- UpdateAppointmentsRequest
RequestedByPatientCode: type changed to string, added nillable="true"
MedicallyConditionedCode: type changed to string, added nillable="true"
04.11.2021 – v3.14
GetFreeSlotsForProcedureResponseCOS
- Added:
MedicalFacilityName
GetPrereservationsForProcedureRequestCOS
PatientBirthDate: mandatory changed to NO
PatientGender: mandatory changed to NO
ReferralDiagnosis: mandatory changed to NO
BookReservationRequestCOS
ReferralDiagnosis: mandatory changed to NO
PatientName: mandatory changed to NO
PatientSurname: mandatory changed to NO
PatientBirthDate: mandatory changed to NO
PatientGender: mandatory changed to NO
StreetName: mandatory changed to NO
StreetNumber: mandatory changed to NO
CityName: mandatory changed to NO
CityPostalCode: mandatory changed to NO
ControlExam: mandatory changed to NO
WantsSpecificDoctor: mandatory changed to NO
WasInformedOfOthers: mandatory changed to NO
10.11.2021 – v3.15
- GetAppointmentsForProcedureResponseHOS
PatientEUCardNumberLength: type changed from <xs:length value="25" /> to <xs:maxLength value="25" />
PatientDocumentNumberLength: type changed from <xs:length value="25" /> to <xs:maxLength value="25" />
17.11.2021 – v3.16
29.11.2021 – v3.17
30.11.2021
07.12.2021
15.12.2021 – v3.18
15.12.2021
21.12.2021 – v3.19
29.12.2021 – v3.20
11.01.2022 – v3.21
19.01.2022 – v3.22
01.02.2022 – v3.23
18.02.2022 – v3.24
08.03.2022 – v3.25
- GetReferralListResponse
- Changed field name and type:
LastAdmissionFacility → LastAdmissionFacilityCode, type changed to BPIType
- Added new fields:
LastAdmissionFacilitySpecificCode
LastAppointmentFacilityName
LastAppointmentFacilityCode
LastAppointmentFacilitySpecificCode
19.04.2022 – v3.26
21.04.2022
03.05.2022 – v3.27
- Added description for fields:
ReferralGroundedCode
UrgencyTypeGrounded
06.05.2022 – v3.28
03.06.2022 – v3.29
14.07.2022 – v3.30
23.08.2022 – v3.31
06.09.2022 – v3.32
12.09.2022 – v3.33
11.10.2022 – v3.34
20.10.2022 – v3.35
07.11.2022 – v3.36
09.11.2022 – v3.36
14.11.2022 – v3.37
28.11.2022 – v3.38
07.12.2022 – v3.38
- Added new COS web method: GetAEUCandidates
- Included: XSDs, XML examples, and descriptions
27.12.2022 – v3.38
28.12.2022 – v3.38
29.12.2022 – v3.38
05.01.2023 – v3.38
18.01.2023 – v3.39
13.02.2023 – v3.40
14.02.2023 – v3.41
28.02.2023 – v3.42
ErrorCodeType
- Added new error:
- Message:
"Poteklo je obdobje v katerem je bilo možno naročanje"
- Code:
2006
GetAEUCandidates
- Response updated with new attributes:
PatientInsuranceIdentifier
PatientUniqueIdentifier
DateConfirmed
DateCreated
MedicalProcedureCode
31.03.2023 – v3.43
07.04.2023 – v3.43
15.05.2023 – v3.44
24.05.2023 – v3.45
- CancelAppointments
- Enabled cancellation of active orders for referrals in statuses:
Izkoriščena
Ni izkoriščena
01.06.2023 – v3.45
01.08.2023 – v3.46
07.09.2023 – v3.47
- GetAEUCandidates
minOccurs value for PatientUniqueIdentifier changed from 1 to 0
08.01.2024 – v3.48
- GetReferralListResponse
- Renamed element:
AllowOrdering → AllowOrderingFacility
- Added elements:
DateOrderingDeadlineFacility
AllowOrderingPatient
DateOrderingDeadlinePatient
11.03.2024 – v3.49
02.04.2024 – v3.49
- GetReferralResponse
- Added elements:
AllowOrderingPatient
DateOrderingDeadlinePatient
AllowOrderingFacility
DateOrderingDeadlineFacility
24.04.2024 – v3.50
16.05.2024 – v3.50
03.07.2024 – v3.51
- AppointmentSummary.xsd
- Changed
minOccurs value from 1 to 0 for elements:
StreetName
StreetNumber
CityName
CityPostalCode
- Changed type of:
PatientEmail → from EmailType to xs:string
28.08.2024 – v3.52
09.09.2024 – v3.53
11.09.2024 – v3.53
- ReferralCancellationReasonType
- Added new codes:
14, 15
- Modified codes:
9, 10, 11, 12 – added Slovenian names/descriptions
- Common.xsd
- Added new codes for restriction purposes of
ReferralCancellationReasonType to simpleType ReferralCancellationReasonType
11.09.2024 – v3.53
11.09.2024 – v3.54
23.10.2024 – v3.54
15.11.2024 – v3.55
AppointmentSummary
(used in GetAppointmentResponse, GetAppointmentsForPatientResponse)
- Added element
DocumentTypeCode
Common.xsd
CreateAppointmentsRequest
- Patient information is not mandatory for DN
- Added element
CareTeamIdentifier
UpdateAppointmentsRequest
- Added element
CareTeamIdentifier
SubmitReferralRequest
- Added element
DocumentTypeCode
GetReferralResponse
- Added element
DocumentTypeCode
GetReferralListResponse
- Added element
DocumentTypeCode
GetAppointmentResponse
- Added element
DocumentTypeCode
GetAppointmentsForPatientResponse
- Added element
DocumentTypeCode
Catalogues
ReferralCancellationReasonType
- Changed name of the rows with codes:
1, 9, 10, 11, 12, 14, 15:
- Old: napotnica → New: napotna listina
ErrorCodeType
- Changed name of the rows with codes:
2003, 2004, 3007, 3012, 3013, 4:
- Old: napotnica → New: napotna listina
AppointmentCancellationReasonType`
- Changed name of the rows with codes:
9, 20
- Old: napotnica → New: napotna listina
SubmitReferralRequest
GetReferralResponse
GetReferralListResponse
CreateAppointmentsRequest
- Type
string used instead of NonEmptyString:
<xs:element minOccurs="0" maxOccurs="1" name="PatientName" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="PatientSurname" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="StreetName" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="StreetNumber" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="CityName" type="xs:string" />
<xs:element minOccurs="0" maxOccurs="1" name="CityPostalCode" type="xs:string" />
- Element
CareTeamIdentifier added at the end:
<xs:element minOccurs="0" maxOccurs="1" name="CareTeamIdentifier" type="xs:string" />
UpdateAppointmentsRequest
CancelAppointmentsResponse
- Fixed grammatical error in the name of the element: changed from "Create..." to "Cancel...".
BookReservationRequestCOS
- Element
DistrictCode: type changed to NonEmptyString.
GetReferralTimelineResponse
- Fixed missing closing bracket (
>) for the <schema> element.
GetAppointmentPdfRequest
BookReservationRequestHOS
- Set
minOccurs = "0" for the following elements:
CountryCode
PatientName
PatientSurname
PatientBirthDate
PatientGenderType
StreetName
StreetNumber
CityName
CityPostalCode
DoctorGivenName
DoctorFamilyName
OrganizationName
OrganizationStatisticalRegion
LinkAppointmentsToNewReferralHOS
This method already existed but was not previously included in the specification. It has now been documented.
This is not a new functionality, but rather a documentation update for completeness.
27.11.2024 – v3.56
20.02.2025 – v3.57
05.03.2025 – v3.58
01.04.2025 – v3.59
07.08.2025 – v3.60
- CreateAppointmentsRequest
- Changed Mandatory (Details for every appointment) from
YES to NO for:
PatientEMail
PatientPhone
PatientMobile
05.09.2025 – v3.60
22.10.2025 – v3.60
28.10.2025 – v3.61
19.01.2026 – v3.62
CreateAppointmentsRequest
- Added four optional elements:
LocationIdentifier
DocIdentifier
DeviceIdentifier
AppointmentEndTime
GetRealisationsForProcedureResponseHOS
- Added new optional element
LocationIdentifier.
- Added new optional element
DeviceIdentifier.
GetAppointmentsForProcedureResponseHOS
- Added three optional elements:
LocationIdentifier
DocIdentifier
DeviceIdentifier
AppointmentSummary
(used in GetAppointmentResponse, GetAppointmentsForPatientResponse
- Added new optional elements :
CareTeamIdentifier,
LocationIdentifier,
DeviceIdentifier,
DocIdentifier
AppointmentRealisationRequest
- Added three optional elements:
LocationIdentifier
CareTeamIdentifier
DeviceIdentifier
BookReservationRequestCOS
- Added five optional elements:
CareTeamIdentifier,
LocationIdentifier
DocIdentifier
DeviceIdentifier,
AppointmentEndTime
BookReservationRequestHOS
- Added five optional elements:
CareTeamIdentifier,
LocationIdentifier
DocIdentifier
DeviceIdentifier,
AppointmentEndTime
UpdateAppointmentsRequest
- Added four optional elements:
LocationIdentifier
DocIdentifier
DeviceIdentifier
AppointmentEndTime
Added new method: GetAllFreeSlotsForProcedureHOS
- Included: XSDs, XML examples, and descriptions