medatixx x.archiv API-Definition (0.9.1)

Download OpenAPI specification:Download

Authentication

bearerAdminAuth

Bearer token representing valid medatixx Admin user

Security scheme type:	HTTP
HTTP Authorization Scheme	bearer
Bearer format	"JWT"

bearerUserAuth

Bearer token representing valid medatixx user

Security scheme type:	HTTP
HTTP Authorization Scheme	bearer
Bearer format	"JWT"

bearerClientAuth

Bearer token representing valid client credentials

Security scheme type:	HTTP
HTTP Authorization Scheme	bearer
Bearer format	"JWT"

token

Creates an JWT authentication token.

Request Body schema: application/x-www-form-urlencoded

grant_type required	string Enum:"client_credentials" "password" The grant type. Use password for bearerUserAuth and bearerAdminAuth. Use client_credentials for bearerClientAuth.
client_id	string The system's unique client id. Only with grant_type client_credentials!
client_secret	string The installation's client secret. Only with grant_type client_credentials!
username	string The login username. Only with grant_type password! Use Admin for bearerAdminAuth or existing username for bearerUserAuth.
password	any The login password. Only with grant_type password!
scope required	string Value:"xarchiv" The requested scope permission

Responses

200

post /token

Override base path for the POST /token operation

https://localhost:20141/token

Response samples

application/json

Copy

Expand all Collapse all

{

"expires_in": 360,
"token": "string"

}

users

Returns a list of users

Authorizations:

bearerUserAuthbearerClientAuth

Responses

200

401

Access denied.

get /users

Local server

https://localhost:20141/xarchiv/users

Response samples

application/json

Copy

Expand all Collapse all

[

{
- "id": "1",
- "surname": "Mustermann",
- "givenName": "Erika",
- "loginName": "Mustermanne",
- "isValid": true,
- "practitionerSet":
  [
  - {
    "id": "1-3",
    "name": "Mustermann, Baronin Erika von",
    "shorthandSymbol": "MUE",
    "isValid": true,
    "separationId": "1"
    }
  ]
}

]

Returns a specific user

Authorizations:

bearerUserAuthbearerClientAuth

path Parameters

required

string

Responses

200

401

Access denied.

404

Resource Not Found. The specified user doesn't exist.

get /users/{id}

Local server

https://localhost:20141/xarchiv/users/{id}

Response samples

application/json

Copy

Expand all Collapse all

{

"id": "1",
"surname": "Mustermann",
"givenName": "Erika",
"loginName": "Mustermanne",
"isValid": true,
"practitionerSet":
[
- {
  - "id": "1-3",
  - "name": "Mustermann, Baronin Erika von",
  - "shorthandSymbol": "MUE",
  - "isValid": true,
  - "separationId": "1"
  }
]

}

practitioners

Returns a list of practitioners

Authorizations:

bearerUserAuthbearerClientAuth

Responses

200

401

Access denied.

get /practitioners

Local server

https://localhost:20141/xarchiv/practitioners

Response samples

application/json

Copy

Expand all Collapse all

[

{
- "id": "1-3",
- "name": "Mustermann, Baronin Erika von",
- "shorthandSymbol": "MUE",
- "isValid": true,
- "separationId": "1"
}

]

Returns a specific practitioner

Authorizations:

bearerUserAuthbearerClientAuth

path Parameters

required

string

Example: "1-2"

Responses

200

401

Access denied.

404

Resource Not Found. The specified practitioner doesn't exist.

get /practitioners/{id}

Local server

https://localhost:20141/xarchiv/practitioners/{id}

Response samples

application/json

Copy

Expand all Collapse all

{

"id": "1-3",
"name": "Mustermann, Baronin Erika von",
"shorthandSymbol": "MUE",
"isValid": true,
"separationId": "1"

}

patients

Returns a list of patients

Authorizations:

bearerUserAuthbearerClientAuth

query Parameters

_search	string The search token(s) separated by space or comma
_count	boolean Default: false Indicating whether the request should return the count of the found patients
_limit	integer <int32> [ 1 .. 200 ] Default: 50 The number of items to return.
_offset	integer <int32> Default: 0 The number of items to skip before starting to collect the result set.
_sort	integer <int32> Default: 0 Enum:0 1 2 3 4 Specifies the sort order of the found patients. * 0 - by Name, Vorname, Wohnort, PatientNr * 1 - by Name, Vorname, Geburtsdatum, PatientId * 2 - by Vorname, Name, Geburtsdatum, PatientId * 3 - by Geburtsdatum, Name, Vorname, PatientId * 4 - by PatientId, Name, Vorname, Geburtsdatum

header Parameters

xarchiv-Context

required

string

Example: "NB-TESTPC:1:10245:9:1"

"Represents the current request context. Consists of client instance ids, user id and practitioner id. Format: MachineName:WindowsSessionId:ProcessId:UserId:PractitionerId"

Responses

200

400

Bad request. May contain description of the actual error. For instance validation failed on query parameters.

401

Access denied.

get /patients

Local server

https://localhost:20141/xarchiv/patients

Response samples

application/json

Copy

Expand all Collapse all

[

{
- "id": 1,
- "surname": "Mustermann",
- "givenName": "Erika",
- "title": "Baronin",
- "birthDate": "19940524",
- "gender": "M",
- "weight": "string",
- "height": "string",
- "weekOfPregnancy": "string",
- "phone":
  [
  - "string"
  ],
- "healthInsuranceNumber": "string",
- "street": "string",
- "zipCode": "string",
- "city": "string"
}

]

Returns a specific patient

Authorizations:

bearerUserAuthbearerClientAuth

path Parameters

required

integer <int32>

header Parameters

xarchiv-Context

required

string

Example: "NB-TESTPC:1:10245:9:1"

"Represents the current request context. Consists of client instance ids, user id and practitioner id. Format: MachineName:WindowsSessionId:ProcessId:UserId:PractitionerId"

Responses

200

401

Access denied.

404

Resource Not Found. The specified patient doesn't exist.

get /patients/{id}

Local server

https://localhost:20141/xarchiv/patients/{id}

Response samples

application/json

Copy

Expand all Collapse all

{

"id": 1,
"surname": "Mustermann",
"givenName": "Erika",
"title": "Baronin",
"birthDate": "19940524",
"gender": "M",
"weight": "string",
"height": "string",
"weekOfPregnancy": "string",
"phone":
[
- "string"
],
"healthInsuranceNumber": "string",
"street": "string",
"zipCode": "string",
"city": "string"

}

Creates a new document reference entry for the given patient id.

Authorizations:

bearerUserAuthbearerClientAuth

path Parameters

patientId required	integer <int32> The patient's id.
referenceId required	string mediDOK unique image number.

header Parameters

xarchiv-Context

required

string

Example: "NB-TESTPC:1:10245:9:1"

"Represents the current request context. Consists of client instance ids, user id and practitioner id. Format: MachineName:WindowsSessionId:ProcessId:UserId:PractitionerId"

Request Body schema: application/json

title	string mediDOK image name.
category	string mediDOK mapping category.
pointInTime required	string <date-time> UTC DateTime of observation.
source	string mediDOK image source.
description	string mediDOK image description.

Responses

200

Returns 'true' on sucess. Returns 'false' when no entry was created. This may happen when the category is blocked for import.

400

Bad request. May contain description of the actual error. For instance validation failed on query parameters.

401

Access denied.

404

Resource Not Found. The specified patient doesn't exist.

409

Conflict. A document reference with the same 'referenceId' already exists.

post /patients/{patientId}/documents/references/{referenceId}

Local server

https://localhost:20141/xarchiv/patients/{patientId}/documents/references/{referenceId}

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"title": "string",
"category": "string",
"pointInTime": "2019-06-27T10:32:28.000Z",
"source": "string",
"description": "string"

}

Response samples

application/json

Copy

Expand all Collapse all

true

Updates an existing or creates a new document reference entry for the given patient id. When the category is blocked for import but the document reference already exists, it's still updated.

Authorizations:

bearerUserAuthbearerClientAuth

path Parameters

patientId required	integer <int32> The patient's id.
referenceId required	string mediDOK unique image number.

header Parameters

xarchiv-Context

required

string

Example: "NB-TESTPC:1:10245:9:1"

"Represents the current request context. Consists of client instance ids, user id and practitioner id. Format: MachineName:WindowsSessionId:ProcessId:UserId:PractitionerId"

Request Body schema: application/json

title	string mediDOK image name.
category	string mediDOK mapping category.
pointInTime required	string <date-time> UTC DateTime of observation.
source	string mediDOK image source.
description	string mediDOK image description.

Responses

200

Returns 'true' on sucess. Returns 'false' when no entry was updated or created.

400

Bad request. May contain description of the actual error. For instance validation failed on query parameters.

401

Access denied.

404

Resource Not Found. The specified patient doesn't exist.

put /patients/{patientId}/documents/references/{referenceId}

Local server

https://localhost:20141/xarchiv/patients/{patientId}/documents/references/{referenceId}

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"title": "string",
"category": "string",
"pointInTime": "2019-06-27T10:32:28.000Z",
"source": "string",
"description": "string"

}

Response samples

application/json

Copy

Expand all Collapse all

true

Deletes the specified document reference entry for the given patient id.

Authorizations:

bearerUserAuthbearerClientAuth

path Parameters

patientId required	integer <int32> The patient's public id.
referenceId required	string The document reference's id.

header Parameters

xarchiv-Context

required

string

Example: "NB-TESTPC:1:10245:9:1"

"Represents the current request context. Consists of client instance ids, user id and practitioner id. Format: MachineName:WindowsSessionId:ProcessId:UserId:PractitionerId"

Responses

200

401

Access denied.

404

Resource Not Found. The specified patient's document reference doesn't exist.

delete /patients/{patientId}/documents/references/{referenceId}

Local server

https://localhost:20141/xarchiv/patients/{patientId}/documents/references/{referenceId}

Response samples

application/json

Copy

Expand all Collapse all

true

Creates a new examinations entry for the given patient id.

Authorizations:

bearerUserAuthbearerClientAuth

path Parameters

patientId

required

integer <int32>

The patient's id.

header Parameters

xarchiv-Context

required

string

Example: "NB-TESTPC:1:10245:9:1"

"Represents the current request context. Consists of client instance ids, user id and practitioner id. Format: MachineName:WindowsSessionId:ProcessId:UserId:PractitionerId"

Request Body schema: application/json

category required	string Enum:"KATB" "KATW" "KATE" "KATR" mediDOK mapping category. * 'KATB' - medical findings * 'KATW' - DICOM worklist * 'KATE' - Thieme/EDP * 'KATR' - DICOM structured report
pointInTime required	string <date-time> UTC DateTime of observation.
text	string mediDOK examination text.

Responses

200

Returns 'true' on sucess. Returns 'false' when no entry was created. This may happen when the category is blocked for import.

400

Bad request. May contain description of the actual error. For instance validation failed on query parameters.

401

Access denied.

404

Resource Not Found. The specified patient doesn't exist.

post /patients/{patientId}/examinations

Local server

https://localhost:20141/xarchiv/patients/{patientId}/examinations

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"category": "KATB",
"pointInTime": "2019-06-27T10:32:28.000Z",
"text": "string"

}

Response samples

application/json

Copy

Expand all Collapse all

true

ping

Pings the server.

Responses

200

Ok. Server is up and running

get /ping

Local server

https://localhost:20141/xarchiv/ping

Response samples

application/json

Copy

Expand all Collapse all

"pong"

system

Exchange pairing info. An bearer token issued to the admin user of medatixx is needed.

Authorizations:

bearerAdminAuth

Request Body schema: application/json

apiKey	string mediDOK API-Key
serverBaseUri	string Base uri of the mediDOK communication service

Responses

200

401

Access denied.

post /system/pairing

Local server

https://localhost:20141/xarchiv/system/pairing

Request samples

Payload

application/json

Copy

Expand all Collapse all

{

"apiKey": "string",
"serverBaseUri": "https://mediDOK:22222/extern"

}

Response samples

application/json

Copy

Expand all Collapse all

{

"clientId": "string",
"clientSecret": "string"

}

Gets the context of all existing client instances matching the given instance id value.

Authorizations:

bearerUserAuthbearerClientAuth

query Parameters

instanceId

required

string

The client instance id. Format: MachineName:Windows Session Id:Process Id or left side parts of it.

Responses

200

401

Access denied.

404

Resource Not Found. The specified client instance id doesn't exist.

get /system/clientinstances/context

Local server

https://localhost:20141/xarchiv/system/clientinstances/context

Response samples

application/json

Copy

Expand all Collapse all

[

{
- "clientInstanceId": "NB-TESTPC:1:10245",
- "userId": "1",
- "practitionerId": "1-3",
- "patientId": 1
}

]