{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"7e23fa9d-20da-43bd-a27f-53cf7b800a12","name":"MedITEX Rest API v5.10","description":"Use the MedITEX REST API to connect to MedITEX database and build data workflows fitting to your needs. \nBrought to you by CRITEX - Creative IT Experts. Visit **https://ivf.software**.\n\n### Changelog:\nPlease see the changelog to access former versions of this API documentation.\n\n### Data Table:\n| Version | Date | MedITEX version | Description |\n|----------|----------|----------|----------|\n| *[5.10]()* | 08.01.2026 | 4.0.6.0 | - Added new Endpoint PLANNED_CYCLE and PLANNED_CYCLE_ITEMS
- Added new endpoints for App Appointment Treatments and free timeslots for appointments. Restructured the appointment request order + added a worfklow and terminology description.
- Improved description of some MHF Matchcodes
- Added missing RAPMSG12 Status (10: Read)
- Added Embryo payload to PREGNANCY endpoint (already added in MedITEX v4.0.3.4)
- Added information about Client endpoint retry intervals
|\n| *[5.9](https://documenter.getpostman.com/view/24619591/2sB2x5HYLf)* | 11.06.2025 | 4.0.4.1 | - Added new Endpoint PATIENT_SEARCH and explanation for patient subscirption
- Updated Payload of PATIENT_CREATE to include the new subscription object
- Updated endpoints to use lowerCamelCase spelling and added missing clinicUuid field (MedITEX v4.0.4.0)
- Update structure of DELETED_GET Endpoint to include PAD141 and PAD56
- Added documentation for endpoint CREATE_ULTRASOUND
- Added HTTP status code 500 for all GET endpoints.
- Added fields to APPOINTMENT_RESOURCES (SCRE5 and SCRE12)
- PATIENT_GET Endpoint: New nested Partnership array
- PATIENT and PARTNERSHIP endpoints, new matchcode PAR14
|\n| *[5.8](https://documenter.getpostman.com/view/24619591/2sAYHxm3no)* | 12.12.2024 | 4.0.3.0 | - Changed Base URL to use for the testserver
- Changed preffered unique patient identifier from PAD141 to PAD56
- Added information about version flag
- Added information to ITEMSLIMIT parameter
- Added common information about URL encoding of reserved chars.
- Added new endpoint: GET deleted entities
|\n| *[5.7](https://documenter.getpostman.com/view/24619591/2sAXqqdi91)* | 19.09.2024 | 4.0.1.5 | - Added missing field MHENTRY30 (Historical entries)
- Added missing fields to Appointment treatment
- Added description for endpoint /create_message (Messages)
- Added documentation for /get_endpoints (Endpoints)
- Updated documentation for possible datetime and time format options
|\n| *[5.6](https://documenter.getpostman.com/view/24619591/2sA3e2gVJd)* | 09.07.2024 | 4.0.1.1 | - Added new endpoints cycle insemination (GET/MAP)
- Added missing treatment method(CYCOOCD14)
- Fixed example for <= Operator with timestamp
|\n| *[5.5](https://documenter.getpostman.com/view/24619591/2sA3JFCkNn)* | 24.04.2024 | 4.0.1.0 | - Added header options for CREATE requests
- Added example for WTSR resources
|\n| *[5.4](https://documenter.getpostman.com/view/24619591/2sA3Bg9F2N)* | 09.04.2024 | 4.0.0.6 | Added new endpoints: - GET appointment resource workingtimes
- GET egg day
- GET patient information by egg ID
- GET birth
- GET pregnancy
- GET location information
- GET failed requests
|\n| *[5.3](https://documenter.getpostman.com/view/24619591/2s9YBxXaeJ)* | 05.09.2023 | 3.0.1.1 | - Added new endpoint. CREATE Partner link
- Added missing information to EGG Endpoint
|\n| *[5.2](https://documenter.getpostman.com/view/24619591/2s946mbqoN)* | 18.07.2023 | 3.0.1.0 | Added several endpoints. MAP endpoints replacing the INTERFACE endpoints, providing more detailed information. |\n| *[5.1](https://documenter.getpostman.com/view/16495121/2s93XzxhhZ)* | 17.04.2023 | 3.0.0.1 | Added several matchcodes. Updated example values in responses of INTERFACE endpoints. Provided API credentials for public test server.\n| *[5.0](https://documenter.getpostman.com/view/16495121/2s93CNMYcX)* | 01.03.2023 | 3.0.0.0 | Initial version - Replacing former API documentation on SwaggerHub.\n\n## Getting started\nGet started with MedITEX REST API by forking this collection into your Postman workspace (Use button Run in Postman). \nYou can then use Postman to send requests to the [MedITEX REST API test server](https://restapi.meditex.cloud/).\n\n## Hosting and Sandbox\nMedITEX REST API is an interface to the MedITEX installation of an IVF clinic, hence it's not hosted in the cloud. MedITEX is installed locally within the clinic network, that's why each clinic provides their own server port and credentials. \nHowever, we provide a sandbox which can be used for testing. \n\n| Server | Username | Password |\n|----------|----------|----------|\n| [https://demo.meditex.cloud:18082](https://demo.meditex.cloud:18082) | POSTMAN_DEV | Please ask [support@critex.de](support@critex.de)|\n\n## Overview\n1. You must use a certain username and password to send requests to the API endpoints. For the public test server, it's common credentials. \nFor a production environment (clinic server), credentials (username, password, DNS/IP and port) must be configured individually per clinic and provided by CRITEX support. \n2. The API only responds to HTTPS-secured communications. In a productive environment, the clinic needs to provide a valid SSL certificate to their REST API web server.\n3. The API returns requests responses in [JSON format](https://en.wikipedia.org/wiki/JSON). When an API request returns an error, it is sent in the JSON response as an error key along with detailed information, telling which paret of your payload is invalid or incomplete.\n4. The request method (verb) determines the nature of action you intend to perform. A request made using the `GET` method implies that you want to fetch something from MedITEX database. The `POST` method implies you want to save something new to MedITEX database. \n5. You can access individual resources in the MedITEX database with its unique ID (hashed value by default) per area. For instance, records of area `SCHED` (appointments) might have the same hashed value as records of area `LABSEM` (semen analysis), as the areas are not related to each other. \n\n## Common information\n- **Matchcodes**: Within the MedITEX ecosystem, each key is identified with a static so-called *matchcode*. A matchcode is unique across areas (Areas are e.g. `SCHED`, `PAD`, `LABSEM`, etc.) and will **never** change its identifier. Though, the datatype, field length or the description might change in the future. Please make sure to check the response body of the `MAP` endpoint of each area to lookup the meaning of area matchcodes.\n- **Unique patient identifier:** To only get data of a specific patient, add the Internal Patient ID (`PAD56`) as a query parameter. In order to get all records, omit this matchcode (not recommended). **The `PAD56` matchcode is the primary unique identifier of a patient in a MedITEX database and it is recommended to use it as a query parameter for all subsequent requests to other endpoints as well.**\n- **Datetime format:** The *default date(time) format* is `ISO-8601` (e.g. `2023-01-20T02:25:00.000+01:00`).\n- **Hashing of IDs:** By default, all identifiers are returned as hashed values (`BIGINT`) (Starting from *v5* of all endpoints - see also topic *Versioning*). In the `MAP` endpoints, you can lookup the *Unique hashed ID* of each endpoint in order to link them across areas, e.g. use `STAFF_GET` to identify the hashed ID of a staff to be used in a `HISTORY_ENTRY_CREATE` request. \n- **Server pagination:** Offset-based pagination is enabled for all `GET` endpoints by default (except `MAP` endpoints, as they return static information only). Also when using parameters `PAGE` or `ITEMSLIMIT`, the response header will contain information about the next available page. Please note the exclusiveness of these two parameters. \n- **Versioning:** All endpoints offer dynamic versioning via query parameter `V`. We recommend to always use the latest available version across all endpoints to ensure consistency. Please ask our API team for upcoming version updates on the REST API. \n - The current Version is **5**. Please note that this flag is used to specify the API version and does **not** correspond to the version number of this API documentation.\n- **Special characters:** Please note that special characters like `é` or `À` occupy 2 bytes instead of 1 byte (when considering the maximum size of a VARCHAR field). \n- **Mapping errors:** The response body of `POST` requests will tell you which matchcodes contain invalid data (e.g. *lookup values* coming from the `MAP` counterpart endpoint or strings exceeding their length limit). \n- **Decimal:** Decimal and numeric values must be sent using dots (.) as the decimal separator, not commas.\n- **Reserved Characters:** When using query parameters, reserved characters (e.g., `!`, `#`, `$`, `%`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `/`, `:`, `;`, `=`, `?`, `@`, `[`, `]`) must be URL-encoded to ensure proper interpretation by the API. For example:\n - Space: `%20`\n - `&`: `%26`\n - `/`: `%2F` \n- **Retry Intervals:** Our client endpoints include a default retry policy to prevent data loss during temporary server issues.\n If the destination server:\n - does not respond (timeout/no response), or\n - returns an HTTP 500 (Internal Server Error)\n\n The request is not discarded immediately. Instead, the client will automatically retry sending the same request using the following schedule: 1, 5, 10, 30, 60 minutes (after the initial failed attempt)\n\n\n## Operators\nYou can add special operators to your query that will affect the queried data in a logical way (in addition to the query parameters).\n\n| Operator name | Example | Description |\n|---|---|---|\n| *EQUAL* | ?PAD141='PID_1' | Filters on certain values of a matchcode. If more values should be included in the filter, use the 'IN' operator instead. |\n| *GREATER (OR EQUAL) THAN* | ?SCHED3>='2023-01-20 02:25:00.000' | Filters on a threshold value of a matchcode (e.g. SCHED2 = Appointment end date).|\n| *SMALLER (OR EQUAL) THAN* | ?SCHED2<='2023-01-20 02:25:00.000' | Filters on a threshold value of a matchcode (e.g. SCHED2 = Appointment start date).|\n| *IN* | ?PAD141 IN ('PID_1','PID_2') | Filters matchcode values on *a set* of certain values (comma-separated) (e.g. PAD141 = Patient ID).|\n| *LIKE* | ?SCHED22 LIKE 'Test subject' | Filters matchcode values for a specific substring (case sensitive) (e.g. SCHED22 = Event subject). If you are using '%' in your query string, please note the section in [Common Information](#common-information). A '%' must be sent URL encoded. \n\n## Patient Subscription\nAPI partners can only access patient data for patients they are subscribed to. Please contact MedITEX support to confirm whether your app/software requires explicit patient subscription.\nIf you require patient subscription, please note the following workflow:\n - **Within MedITEX:** Subscriptions can be managed directly through the MedITEX software interface.\n - **Via API:**\n 1. Use the /search_patient endpoint to locate a patient by known details such as email address or phone number. This endpoint returns basic patient data only if a 100% match is found.\n 2. If successful, the response includes patient identifiers (PAD141, PAD56), which are required for the subscription step.\n 3. Use these identifiers in the /create_patient endpoint to subscribe the patient by including the appropriate RESTPM object in the request payload.\n 4. For examples, please check the payloads in the documentation of the respective endpoints or contact us. \n\n\nContact Support:\n Name: MedITEX REST API Support\n Email: support@critex.de","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"24619591","team":2150003,"collectionId":"7e23fa9d-20da-43bd-a27f-53cf7b800a12","publishedId":"2sBXVfjBq1","public":true,"publicUrl":"https://restapi.meditex.cloud","privateUrl":"https://go.postman.co/documentation/24619591-7e23fa9d-20da-43bd-a27f-53cf7b800a12","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.11.4","publishDate":"2026-01-12T07:17:27.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/2f0be0b17fe6842ad6fd13916e780bf43dc319204be7db7d0c84dcd228fdb4e1","favicon":"https://meditex.cloud/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://restapi.meditex.cloud/view/metadata/2sBXVfjBq1"}