eHealth SSL Catalogue service

More information: https://systematic.com/

Contact Info: support.ehealth.servicedesk@systematic.com

Version: 1.0.0

BasePath:/v1

Proprietary

http://apache.org/licenses/LICENSE-2.0.html

Access

APIKey KeyParamName:Authorization KeyInQuery:false KeyInHeader:true

Methods

[ Jump to Models ]

Annotation

post /annotation

Create a new Annotation. (createAnnotation)

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

annotation Annotation (required)

Body Parameter —

Responses

201

The Annotation was successfully created.

400

The request could not be understood Error

500

The server encountered an unexpected condition which prevented it from fulfilling the request. Error

default

Unexpected error Error

delete /annotation/{id}

Delete an Annotation (deleteAnnotation)

Only draft Annotations can be deleted.

Path parameters

id (required)

Path Parameter — The id of the Annotation to delete

Responses

204

The Annotation was successfully deleted.

400

The request could not be understood. Error

500

The server encountered an unexpected condition which prevented it from fulfilling the request. Error

default

unexpected error Error

get /annotations

List Annotations. (listAnnotations)

Query parameters

buyer (required)

Query Parameter — List Annotations related to this buyer

catalogue (optional)

Query Parameter — List Annotations related to this Catalogue

catalogueItem (optional)

Query Parameter — List Annotations related to this CatalogueItem

Return type

array[Annotation]

Example data

Content-Type: application/json

[ {
  "catalogueItem" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue-item/4342",
  "name" : "eHealth/device-type",
  "id" : "42352",
  "value" : {
    "system" : "http://ehealth.sundhed.dk/vs/device-measuring-quality",
    "code" : "MEDIUM",
    "display" : "Precision < 0.5kg"
  },
  "buyer" : "https://ssl-order.ehealth.sundhed.dk/v1/party/313",
  "status" : { }
}, {
  "catalogueItem" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue-item/4342",
  "name" : "eHealth/device-type",
  "id" : "42352",
  "value" : {
    "system" : "http://ehealth.sundhed.dk/vs/device-measuring-quality",
    "code" : "MEDIUM",
    "display" : "Precision < 0.5kg"
  },
  "buyer" : "https://ssl-order.ehealth.sundhed.dk/v1/party/313",
  "status" : { }
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Successfully listed all matching Annotations.

400

The request could not be understood. Error

500

The server encountered an unexpected condition which prevented it from fulfilling the request. Error

default

unexpected error Error

put /annotation

Update an Annotation. (updateAnnotation)

id property is required.

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

annotation Annotation (required)

Body Parameter —

Responses

204

The Annotation was successfully updated.

400

The request could not be understood. Error

500

The server encountered an unexpected condition which prevented it from fulfilling the request. Error

default

unexpected error Error

BlackList

post /black-list

Create new black-list (createBlackList)

Create new black-list

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

blackList BlackList (required)

Body Parameter — black-list which should be created.

Responses

201

The black-list was successfully created

400

Invalid input Error

500

The server encountered an unexpected condition which prevented it from fulfilling the request Error

default

Unexpected error Error

delete /black-list/{id}

Delete black-list (deleteBlackList)

Path parameters

id (required)

Path Parameter — The id of the black-list to delete

Responses

204

The black-list was successfully deleted.

400

Invalid input Error

500

The server encountered an unexpected condition which prevented it from fulfilling the request. Error

default

Unexpected error Error

get /black-list/{id}

Return black-list by id (getBlackListById)

Return black-list by id

Path parameters

id (required)

Path Parameter — Id of black-list

Return type

BlackList

Example data

Content-Type: application/json

{
  "item" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue-item/94a67a8d-447e-4f11-a002-81779e326450",
  "patient" : "https://ehealth.sundhed.dk/patient/fhir/Patient/1566241",
  "id" : "3"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

The black-list was successfully returned BlackList

400

Invalid input Error

404

The black-list not found Error

500

The server encountered an unexpected condition which prevented it from fulfilling the request Error

default

Unexpected error Error

get /black-list

Search black-lists by parameters (getBlackLists)

Search black-list by parameters

Query parameters

patient (optional)

Query Parameter — Multiple patient in clinical domain reference values can be provided

Return type

array[BlackList]

Example data

Content-Type: application/json

[ {
  "item" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue-item/94a67a8d-447e-4f11-a002-81779e326450",
  "patient" : "https://ehealth.sundhed.dk/patient/fhir/Patient/1566241",
  "id" : "3"
}, {
  "item" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue-item/94a67a8d-447e-4f11-a002-81779e326450",
  "patient" : "https://ehealth.sundhed.dk/patient/fhir/Patient/1566241",
  "id" : "3"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

List of black-lists was successfully returned

400

Invalid input Error

500

The server encountered an unexpected condition which prevented it from fulfilling the request Error

default

Unexpected error Error

Catalogue

post /catalogue

Create a new Catalogue. (createCatalogue)

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

catalogue Catalogue (required)

Body Parameter —

Responses

201

The Catalogue was successfully created.

400

The request could not be understood Error

500

The server encountered an unexpected condition which prevented it from fulfilling the request. Error

default

Unexpected error Error

get /catalogue/{id}

Get a Catalogue (getCatalogue)

Path parameters

id (required)

Path Parameter — The id of the Catalogue to get.

Return type

Catalogue

Example data

Content-Type: application/json

{
  "seller" : "https://ssl-order.ehealth.sundhed.dk/v1/party/312",
  "identifiers" : [ {
    "system" : "urn:ietf:rfc:3986",
    "assigner" : "Danish Health Authorities",
    "value" : "NUC8766"
  }, {
    "system" : "urn:ietf:rfc:3986",
    "assigner" : "Danish Health Authorities",
    "value" : "NUC8766"
  } ],
  "name" : "Year 2020 catalogue",
  "id" : "432542",
  "status" : { }
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

The requested Catalogue was found. Catalogue

404

Catalogue not found Error

default

unexpected error Error

get /catalogue/{id}/details

Get details of catalogue with specific id (getDetails)

Path parameters

id (required)

Path Parameter — The id of the Catalogue details to get. format: uuid

Return type

CatalogueDetails

Example data

Content-Type: application/json

{
  "catalogueItems" : [ {
    "catalogueItemType" : "DeviceModel",
    "identifiers" : [ {
      "system" : "urn:ietf:rfc:3986",
      "assigner" : "Danish Health Authorities",
      "value" : "NUC8766"
    }, {
      "system" : "urn:ietf:rfc:3986",
      "assigner" : "Danish Health Authorities",
      "value" : "NUC8766"
    } ],
    "name" : "StarTron SuperSpiro VI",
    "description" : "Multipurpose spirometer for wheel chair mounting. Battery supply only. No powerbrick.",
    "id" : "423341",
    "supersededBy" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue-item/99822",
    "catalogue" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue/213",
    "relatedTo" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue-item/11",
    "status" : { }
  }, {
    "catalogueItemType" : "DeviceModel",
    "identifiers" : [ {
      "system" : "urn:ietf:rfc:3986",
      "assigner" : "Danish Health Authorities",
      "value" : "NUC8766"
    }, {
      "system" : "urn:ietf:rfc:3986",
      "assigner" : "Danish Health Authorities",
      "value" : "NUC8766"
    } ],
    "name" : "StarTron SuperSpiro VI",
    "description" : "Multipurpose spirometer for wheel chair mounting. Battery supply only. No powerbrick.",
    "id" : "423341",
    "supersededBy" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue-item/99822",
    "catalogue" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue/213",
    "relatedTo" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue-item/11",
    "status" : { }
  } ],
  "catalogue" : {
    "seller" : "https://ssl-order.ehealth.sundhed.dk/v1/party/312",
    "identifiers" : [ {
      "system" : "urn:ietf:rfc:3986",
      "assigner" : "Danish Health Authorities",
      "value" : "NUC8766"
    }, {
      "system" : "urn:ietf:rfc:3986",
      "assigner" : "Danish Health Authorities",
      "value" : "NUC8766"
    } ],
    "name" : "Year 2020 catalogue",
    "id" : "432542",
    "status" : { }
  }
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

The requested Catalogue details were found. CatalogueDetails

404

Catalogue not found Error

500

The server encountered an unexpected condition which prevented it from fulfilling the request. Error

get /catalogues

List all catalogues. (listCatalogues)

Query parameters

seller (required)

Query Parameter —

Return type

array[Catalogue]

Example data

Content-Type: application/json

[ {
  "seller" : "https://ssl-order.ehealth.sundhed.dk/v1/party/312",
  "identifiers" : [ {
    "system" : "urn:ietf:rfc:3986",
    "assigner" : "Danish Health Authorities",
    "value" : "NUC8766"
  }, {
    "system" : "urn:ietf:rfc:3986",
    "assigner" : "Danish Health Authorities",
    "value" : "NUC8766"
  } ],
  "name" : "Year 2020 catalogue",
  "id" : "432542",
  "status" : { }
}, {
  "seller" : "https://ssl-order.ehealth.sundhed.dk/v1/party/312",
  "identifiers" : [ {
    "system" : "urn:ietf:rfc:3986",
    "assigner" : "Danish Health Authorities",
    "value" : "NUC8766"
  }, {
    "system" : "urn:ietf:rfc:3986",
    "assigner" : "Danish Health Authorities",
    "value" : "NUC8766"
  } ],
  "name" : "Year 2020 catalogue",
  "id" : "432542",
  "status" : { }
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Successfully listed all matching Catalogues.

400

The request could not be understood. Error

500

The server encountered an unexpected condition which prevented it from fulfilling the request. Error

default

unexpected error Error

put /catalogue

Update a Catalogue. (updateCatalogue)

id property is required.

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

catalogue Catalogue (required)

Body Parameter —

Responses

204

The Catalogue was successfully updated.

400

The request could not be understood. Error

500

The server encountered an unexpected condition which prevented it from fulfilling the request. Error

default

unexpected error Error

CatalogueItem

post /catalogue-item

Create a new CatalogueItem. (createCatalogueItem)

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

catalogueItem CatalogueItem (required)

Body Parameter — Must be either a "Service" or "DeviceModel" object. The value of the discriminator "catalogueItemType" is used to distinguish between object types.

Responses

201

The CatalogueItem was successfully created.

400

The request could not be understood Error

500

The server encountered an unexpected condition which prevented it from fulfilling the request. Error

default

Unexpected error Error

get /catalogue-item/{id}

Get a CatalogueItem (getCatalogueItem)

Path parameters

id (required)

Path Parameter — The id of the CatalogueItem to get.

Return type

CatalogueItem

Example data

Content-Type: application/json

{
  "catalogueItemType" : "DeviceModel",
  "identifiers" : [ {
    "system" : "urn:ietf:rfc:3986",
    "assigner" : "Danish Health Authorities",
    "value" : "NUC8766"
  }, {
    "system" : "urn:ietf:rfc:3986",
    "assigner" : "Danish Health Authorities",
    "value" : "NUC8766"
  } ],
  "name" : "StarTron SuperSpiro VI",
  "description" : "Multipurpose spirometer for wheel chair mounting. Battery supply only. No powerbrick.",
  "id" : "423341",
  "supersededBy" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue-item/99822",
  "catalogue" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue/213",
  "relatedTo" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue-item/11",
  "status" : { }
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

The requested CatalogueItem was found. CatalogueItem

404

CatalogueItem not found Error

default

unexpected error Error

get /catalogue-items

List CatalogueItems. (listCatalogueItems)

This operation can be used to search for CatalogueItems available to a buyer given different criteria. At least one of the catalogue, annotation or package parameters must supplied. It is not possible to combine the package parameter with the catalogue or annotation parameters

Query parameters

buyer (required)

Query Parameter — Filter out CatalogueItems not available to this buyer. E.g. https://ssl-order.ehealth.sundhed.dk/v1/party/fd884111-ad48-4c62-83f0-5f447ec43a64

catalogue (optional)

Query Parameter — Filter out CatalogueItems not part of the given Catalogue. E.g. https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue/94a67a8d-447e-4f11-a002-81779e326450

package (optional)

Query Parameter — Filter out CatalogueItems not part of the given Package. E.g. https://ssl-catalogue.ehealth.sundhed.dk/v1/package/2311ef62-8b91-4e7a-b936-7456c54e1af7

annotation (optional)

Query Parameter — Filter out CatalogueItems not having all of the given Annotations. E.g. eHealth/device-metric-measuring-quality-initial:http://ehealth.sundhed.dk/cs/device-measuring-quality/low-precision

patient (optional)

Query Parameter — Filter out CatalogueItems that is black-listed for the given Patient. E.g. https://patient.ehealth.sundhed.dk/fhir/Patient/1566241

Return type

array[CatalogueItem]

Example data

Content-Type: application/json

[ {
  "catalogueItemType" : "DeviceModel",
  "identifiers" : [ {
    "system" : "urn:ietf:rfc:3986",
    "assigner" : "Danish Health Authorities",
    "value" : "NUC8766"
  }, {
    "system" : "urn:ietf:rfc:3986",
    "assigner" : "Danish Health Authorities",
    "value" : "NUC8766"
  } ],
  "name" : "StarTron SuperSpiro VI",
  "description" : "Multipurpose spirometer for wheel chair mounting. Battery supply only. No powerbrick.",
  "id" : "423341",
  "supersededBy" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue-item/99822",
  "catalogue" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue/213",
  "relatedTo" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue-item/11",
  "status" : { }
}, {
  "catalogueItemType" : "DeviceModel",
  "identifiers" : [ {
    "system" : "urn:ietf:rfc:3986",
    "assigner" : "Danish Health Authorities",
    "value" : "NUC8766"
  }, {
    "system" : "urn:ietf:rfc:3986",
    "assigner" : "Danish Health Authorities",
    "value" : "NUC8766"
  } ],
  "name" : "StarTron SuperSpiro VI",
  "description" : "Multipurpose spirometer for wheel chair mounting. Battery supply only. No powerbrick.",
  "id" : "423341",
  "supersededBy" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue-item/99822",
  "catalogue" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue/213",
  "relatedTo" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue-item/11",
  "status" : { }
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

Successfully listed all matching CatalogueItems.

400

The request could not be understood. Error

500

The server encountered an unexpected condition which prevented it from fulfilling the request. Error

default

unexpected error Error

put /catalogue-item

Update a CatalogueItem. (updateCatalogueItem)

id property is required.

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

catalogueItem CatalogueItem (required)

Body Parameter —

Responses

204

The CatalogueItem was successfully updated.

400

The request could not be understood. Error

404

The CatalogueItem not found Error

500

The server encountered an unexpected condition which prevented it from fulfilling the request. Error

default

unexpected error Error

Package

post /package

Create new package (createPackage)

Create new package

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

package Package (required)

Body Parameter — The package which should be created.

Responses

201

The package was successfully created

400

Invalid input Error

500

The server encountered an unexpected condition which prevented it from fulfilling the request Error

delete /package/{id}

Delete package by id (deletePackageById)

Delete package by id

Path parameters

id (required)

Path Parameter — The package id format: uuid

Responses

204

The package was successfully deleted.

400

Invalid input Error

500

The server encountered an unexpected condition which prevented it from fulfilling the request. Error

get /package/{id}

Get package by id (getPackageById)

Get package by id

Path parameters

id (required)

Path Parameter — The package id format: uuid

Return type

Package

Example data

Content-Type: application/json

{
  "whiteListRefs" : [ "https://ssl-catalogue.ehealth.sundhed.dk/v1/white-list/94a67a8d-447e-4f11-a002-81779e326450", "https://ssl-catalogue.ehealth.sundhed.dk/v1/white-list/94a67a8d-447e-4f11-a002-81779e326450" ],
  "name" : "Set of COPD monitoring equipment",
  "buyerRef" : "https://ssl-order.ehealth.sundhed.dk/v1/party/313",
  "id" : "94a67a8d-447e-4f11-a002-81779e326450",
  "status" : { }
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

The package was successfully returned Package

400

Invalid input Error

404

The package was not found Error

500

The server encountered an unexpected condition which prevented it from fulfilling the request Error

get /package/{id}/details

Get package details by id (getPackageDetailsById)

Get package details by id

Path parameters

id (required)

Path Parameter — The package id format: uuid

Return type

PackageDetails

Example data

Content-Type: application/json

{
  "package" : {
    "whiteListRefs" : [ "https://ssl-catalogue.ehealth.sundhed.dk/v1/white-list/94a67a8d-447e-4f11-a002-81779e326450", "https://ssl-catalogue.ehealth.sundhed.dk/v1/white-list/94a67a8d-447e-4f11-a002-81779e326450" ],
    "name" : "Set of COPD monitoring equipment",
    "buyerRef" : "https://ssl-order.ehealth.sundhed.dk/v1/party/313",
    "id" : "94a67a8d-447e-4f11-a002-81779e326450",
    "status" : { }
  },
  "whiteLists" : [ {
    "item" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue-item/94a67a8d-447e-4f11-a002-81779e326450",
    "id" : "2",
    "buyer" : "http://ssl-order.ehealth.sundhed.dk/v1/party/456"
  }, {
    "item" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue-item/94a67a8d-447e-4f11-a002-81779e326450",
    "id" : "2",
    "buyer" : "http://ssl-order.ehealth.sundhed.dk/v1/party/456"
  } ],
  "catalogueItems" : [ {
    "catalogueItemType" : "DeviceModel",
    "identifiers" : [ {
      "system" : "urn:ietf:rfc:3986",
      "assigner" : "Danish Health Authorities",
      "value" : "NUC8766"
    }, {
      "system" : "urn:ietf:rfc:3986",
      "assigner" : "Danish Health Authorities",
      "value" : "NUC8766"
    } ],
    "name" : "StarTron SuperSpiro VI",
    "description" : "Multipurpose spirometer for wheel chair mounting. Battery supply only. No powerbrick.",
    "id" : "423341",
    "supersededBy" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue-item/99822",
    "catalogue" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue/213",
    "relatedTo" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue-item/11",
    "status" : { }
  }, {
    "catalogueItemType" : "DeviceModel",
    "identifiers" : [ {
      "system" : "urn:ietf:rfc:3986",
      "assigner" : "Danish Health Authorities",
      "value" : "NUC8766"
    }, {
      "system" : "urn:ietf:rfc:3986",
      "assigner" : "Danish Health Authorities",
      "value" : "NUC8766"
    } ],
    "name" : "StarTron SuperSpiro VI",
    "description" : "Multipurpose spirometer for wheel chair mounting. Battery supply only. No powerbrick.",
    "id" : "423341",
    "supersededBy" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue-item/99822",
    "catalogue" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue/213",
    "relatedTo" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue-item/11",
    "status" : { }
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

The package was successfully returned PackageDetails

400

Invalid input Error

404

The package was not found Error

500

The server encountered an unexpected condition which prevented it from fulfilling the request Error

get /packages

Get all packages accessible for the current user context (getPackages)

Get all packages accessible for the current user context

Query parameters

status (optional)

Query Parameter — List only packages with this Status

Return type

array[Package]

Example data

Content-Type: application/json

[ {
  "whiteListRefs" : [ "https://ssl-catalogue.ehealth.sundhed.dk/v1/white-list/94a67a8d-447e-4f11-a002-81779e326450", "https://ssl-catalogue.ehealth.sundhed.dk/v1/white-list/94a67a8d-447e-4f11-a002-81779e326450" ],
  "name" : "Set of COPD monitoring equipment",
  "buyerRef" : "https://ssl-order.ehealth.sundhed.dk/v1/party/313",
  "id" : "94a67a8d-447e-4f11-a002-81779e326450",
  "status" : { }
}, {
  "whiteListRefs" : [ "https://ssl-catalogue.ehealth.sundhed.dk/v1/white-list/94a67a8d-447e-4f11-a002-81779e326450", "https://ssl-catalogue.ehealth.sundhed.dk/v1/white-list/94a67a8d-447e-4f11-a002-81779e326450" ],
  "name" : "Set of COPD monitoring equipment",
  "buyerRef" : "https://ssl-order.ehealth.sundhed.dk/v1/party/313",
  "id" : "94a67a8d-447e-4f11-a002-81779e326450",
  "status" : { }
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

List of packages was successfully returned

400

Invalid input Error

500

The server encountered an unexpected condition which prevented it from fulfilling the request Error

patch /package/{id}

Patch selected fields of the given package (patchPackage)

Patch selected fields of the given package

Path parameters

id (required)

Path Parameter — The package id format: uuid

Consumes

This API call consumes the following media types via the request header:

application/json-patch+json

Request body

jsonPatch PatchRequest (required)

Body Parameter — The JSON patch object

Responses

204

The package was successfully updated.

400

Invalid input Error

404

The package was not found Error

500

The server encountered an unexpected condition which prevented it from fulfilling the request Error

Problem

post /problem

Create new problem (createProblem)

Create new problem

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

problem Problem (required)

Body Parameter — The problem which should be created.

Responses

201

The problem was successfully created

400

Invalid input Error

500

The server encountered an unexpected condition which prevented it from fulfilling the request Error

delete /problem/{id}

Delete problem by id (deleteProblemById)

Delete problem by id

Path parameters

id (required)

Path Parameter — The problem id format: uuid

Responses

204

The problem was successfully deleted.

400

Invalid input Error

500

The server encountered an unexpected condition which prevented it from fulfilling the request. Error

get /problem/{id}

Get problem by id (findProblemById)

Get problem by id

Path parameters

id (required)

Path Parameter — The problem id format: uuid

Return type

Problem

Example data

Content-Type: application/json

{
  "description" : "Device resets when pressing 'Start' button",
  "catalogueItemRefs" : [ "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue-item/94a67a8d-447e-4f11-a002-81779e326450", "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue-item/94a67a8d-447e-4f11-a002-81779e326450" ],
  "id" : "94a67a8d-447e-4f11-a002-81779e326450",
  "resolution" : "Turn the device off and on again",
  "timestamp" : "2020-01-01T01:00:00Z"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

The problem was successfully returned Problem

400

Invalid input Error

404

The problem was not found Error

500

The server encountered an unexpected condition which prevented it from fulfilling the request Error

get /problem/{id}/details

Get problem details by id (findProblemDetailsById)

Get problem details by id

Path parameters

id (required)

Path Parameter — The problem id format: uuid

Return type

ProblemDetails

Example data

Content-Type: application/json

{
  "problem" : {
    "description" : "Device resets when pressing 'Start' button",
    "catalogueItemRefs" : [ "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue-item/94a67a8d-447e-4f11-a002-81779e326450", "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue-item/94a67a8d-447e-4f11-a002-81779e326450" ],
    "id" : "94a67a8d-447e-4f11-a002-81779e326450",
    "resolution" : "Turn the device off and on again",
    "timestamp" : "2020-01-01T01:00:00Z"
  },
  "catalogueItems" : [ {
    "catalogueItemType" : "DeviceModel",
    "identifiers" : [ {
      "system" : "urn:ietf:rfc:3986",
      "assigner" : "Danish Health Authorities",
      "value" : "NUC8766"
    }, {
      "system" : "urn:ietf:rfc:3986",
      "assigner" : "Danish Health Authorities",
      "value" : "NUC8766"
    } ],
    "name" : "StarTron SuperSpiro VI",
    "description" : "Multipurpose spirometer for wheel chair mounting. Battery supply only. No powerbrick.",
    "id" : "423341",
    "supersededBy" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue-item/99822",
    "catalogue" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue/213",
    "relatedTo" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue-item/11",
    "status" : { }
  }, {
    "catalogueItemType" : "DeviceModel",
    "identifiers" : [ {
      "system" : "urn:ietf:rfc:3986",
      "assigner" : "Danish Health Authorities",
      "value" : "NUC8766"
    }, {
      "system" : "urn:ietf:rfc:3986",
      "assigner" : "Danish Health Authorities",
      "value" : "NUC8766"
    } ],
    "name" : "StarTron SuperSpiro VI",
    "description" : "Multipurpose spirometer for wheel chair mounting. Battery supply only. No powerbrick.",
    "id" : "423341",
    "supersededBy" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue-item/99822",
    "catalogue" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue/213",
    "relatedTo" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue-item/11",
    "status" : { }
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

The problem was successfully returned ProblemDetails

400

Invalid input Error

404

The problem was not found Error

500

The server encountered an unexpected condition which prevented it from fulfilling the request Error

get /problems

Get all problems accessible for the current user context (getProblems)

Get all problems accessible for the current user context

Return type

Problems

Example data

Content-Type: application/json

{
  "catalogueItems" : [ {
    "catalogueItemType" : "DeviceModel",
    "identifiers" : [ {
      "system" : "urn:ietf:rfc:3986",
      "assigner" : "Danish Health Authorities",
      "value" : "NUC8766"
    }, {
      "system" : "urn:ietf:rfc:3986",
      "assigner" : "Danish Health Authorities",
      "value" : "NUC8766"
    } ],
    "name" : "StarTron SuperSpiro VI",
    "description" : "Multipurpose spirometer for wheel chair mounting. Battery supply only. No powerbrick.",
    "id" : "423341",
    "supersededBy" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue-item/99822",
    "catalogue" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue/213",
    "relatedTo" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue-item/11",
    "status" : { }
  }, {
    "catalogueItemType" : "DeviceModel",
    "identifiers" : [ {
      "system" : "urn:ietf:rfc:3986",
      "assigner" : "Danish Health Authorities",
      "value" : "NUC8766"
    }, {
      "system" : "urn:ietf:rfc:3986",
      "assigner" : "Danish Health Authorities",
      "value" : "NUC8766"
    } ],
    "name" : "StarTron SuperSpiro VI",
    "description" : "Multipurpose spirometer for wheel chair mounting. Battery supply only. No powerbrick.",
    "id" : "423341",
    "supersededBy" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue-item/99822",
    "catalogue" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue/213",
    "relatedTo" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue-item/11",
    "status" : { }
  } ],
  "problems" : [ {
    "description" : "Device resets when pressing 'Start' button",
    "catalogueItemRefs" : [ "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue-item/94a67a8d-447e-4f11-a002-81779e326450", "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue-item/94a67a8d-447e-4f11-a002-81779e326450" ],
    "id" : "94a67a8d-447e-4f11-a002-81779e326450",
    "resolution" : "Turn the device off and on again",
    "timestamp" : "2020-01-01T01:00:00Z"
  }, {
    "description" : "Device resets when pressing 'Start' button",
    "catalogueItemRefs" : [ "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue-item/94a67a8d-447e-4f11-a002-81779e326450", "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue-item/94a67a8d-447e-4f11-a002-81779e326450" ],
    "id" : "94a67a8d-447e-4f11-a002-81779e326450",
    "resolution" : "Turn the device off and on again",
    "timestamp" : "2020-01-01T01:00:00Z"
  } ]
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

List of problems was successfully returned Problems

400

Invalid input Error

500

The server encountered an unexpected condition which prevented it from fulfilling the request Error

patch /problem/{id}

Patch selected fields of the given problem (patchProblem)

Patch selected fields of the given problem

Path parameters

id (required)

Path Parameter — The problem id format: uuid

Consumes

This API call consumes the following media types via the request header:

application/json-patch+json

Request body

jsonPatch PatchRequest (required)

Body Parameter — The JSON patch object

Responses

204

The problem was successfully updated.

400

Invalid input Error

404

The problem was not found Error

500

The server encountered an unexpected condition which prevented it from fulfilling the request Error

WhiteList

post /white-list

Create new white-list (createWhiteList)

Create new white-list

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

whiteList WhiteList (required)

Body Parameter — The white-list which should be created.

Responses

201

The white-list was successfully created

400

Invalid input Error

500

The server encountered an unexpected condition which prevented it from fulfilling the request Error

default

Unexpected error Error

delete /white-list/{id}

Delete white-list (deleteWhiteList)

Path parameters

id (required)

Path Parameter — The id of the white-list to delete

Responses

204

The white-list was successfully deleted.

400

Invalid input Error

500

The server encountered an unexpected condition which prevented it from fulfilling the request. Error

default

Unexpected error Error

get /white-list/{id}

Return white-list by id (getWhiteListById)

Return white-list by id

Path parameters

id (required)

Path Parameter — Id of white-list

Return type

WhiteList

Example data

Content-Type: application/json

{
  "item" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue-item/94a67a8d-447e-4f11-a002-81779e326450",
  "id" : "2",
  "buyer" : "http://ssl-order.ehealth.sundhed.dk/v1/party/456"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

The white-list was successfully returned WhiteList

400

Invalid input Error

404

The black-list not found Error

500

The server encountered an unexpected condition which prevented it from fulfilling the request Error

default

Unexpected error Error

get /white-list

Search white-lists by parameters (getWhiteLists)

Search white-list by parameters

Query parameters

buyer (optional)

Query Parameter — Multiple buyer refernce values can be provided

Return type

array[WhiteList]

Example data

Content-Type: application/json

[ {
  "item" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue-item/94a67a8d-447e-4f11-a002-81779e326450",
  "id" : "2",
  "buyer" : "http://ssl-order.ehealth.sundhed.dk/v1/party/456"
}, {
  "item" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue-item/94a67a8d-447e-4f11-a002-81779e326450",
  "id" : "2",
  "buyer" : "http://ssl-order.ehealth.sundhed.dk/v1/party/456"
} ]

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

List of white-lists was successfully returned

400

Invalid input Error

500

The server encountered an unexpected condition which prevented it from fulfilling the request Error

default

Unexpected error Error

Models

[ Jump to Methods ]

Annotation -
AnnotationStatus -
BlackList -
Catalogue -
CatalogueDetails -
CatalogueItem -
CatalogueItemStatus -
CatalogueStatus -
Coding -
Error -
Identifier -
Package -
PackageDetails -
PackageStatus -
PatchDocument -
PatchRequest -
Problem -
ProblemDetails -
Problems -
WhiteList -
DeviceModel -
Service -

`Annotation` - Up

id (optional)

String Unique ID of this annotation.

catalogueItem

String Reference to Catalogue item which is annotated by this resource.

buyer (optional)

String Reference to BuyerCustomerParty for whom this annotation is relevant.

name

String Descriptive name of the annotation, must apply to the format of "[A-Za-z0-9\-\_/]+"

status (optional)

AnnotationStatus

value (optional)

Coding

`AnnotationStatus` - Up

`BlackList` - Up

id (optional)

String Unique ID of this black-list. Assigned by server

patient

String Reference to the corresponding ehealth-patient in the clinical domain. Pattern should be used ^(?:http(s)?://)?[\w.-]+(?:.[\w.-]+)+[\w-._~:/?#[]@!$&'()*+,;=.]+/Patient/\d+$

item (optional)

String Reference to catalog item which were put in black-list by patient

`Catalogue` - Up

id (optional)

String Unique ID of this catalogue.

identifiers (optional)

array[Identifier] Identifiers to connect Catalogue to external content available in other frameworks or protocols.

seller (optional)

String Reference to SellerSupplierParty who offers the items in this catalogue.

name

String A human readable short headline describing this catalogue.

status

CatalogueStatus

`CatalogueDetails` - Up

catalogue (optional)

Catalogue Catalogue with details.

catalogueItems (optional)

array[CatalogueItem]

`CatalogueItem` - Up

id (optional)

String Unique ID of this catalogue item.

catalogueItemType

String Type discriminator. Legal values are "DeviceModel" and "Service".

identifiers (optional)

array[Identifier] Identifiers to connect CatalogueItem to external content available in other frameworks or protocols.

relatedTo (optional)

String Reference to related catalog item.

catalogue

String Reference to catalog, this item belongs to.

name

String A human readable short headline describing this catalogue item.

description (optional)

String A human readable detailed of this catalogue item (markdown format supported).

status

CatalogueItemStatus

supersededBy (optional)

String Reference to another catalogue item which supersedes this one.

`CatalogueItemStatus` - Up

`CatalogueStatus` - Up

`Coding` - Up

Coding system from clinical domain.

system

String A URI string referring the Identity of the terminology system format: uri

code

String Code value taken from a set of controlled strings defined in the system

display (optional)

String Human-readable value taken from a set of controlled strings defined in the system

`Error` - Up

An business process error reported by the server.

UUID Unique ID of this error. format: uuid

time

Date Date and time this error occurred. format: date-time

code (optional)

String A protocol defined code allowing the client to understand the error and act appropriately format: string

message

String An English text describing the error in end-user terms. format: string

technicalDetails (optional)

String An detailed technical description of an internal, non-business error format: string

`Identifier` - Up

A numeric or alphanumeric string that is associated with a single object or entity within a given system. Typically, identifiers are used to connect content in resources to external content available in other frameworks or protocols. Identifiers are associated with objects and may be changed or retired due to human or system process and errors.

system (optional)

String The namespace for the identifier value

value (optional)

String The value that is unique

assigner (optional)

String Organization that issued id (may be just text)

`Package` - Up

A package is defined by the name, has a status and references to the selected white-lists

id (optional)

UUID Unique ID of this package. Assigned by server format: uuid

name

String Name of the package

status

PackageStatus

buyerRef

String Reference to the buyer party owning the package

whiteListRefs (optional)

array[String] References to the selected white-lists

`PackageDetails` - Up

Package and the related white-list and catalogue items

package (optional)

Package

whiteLists (optional)

array[WhiteList]

catalogueItems (optional)

array[CatalogueItem]

`PackageStatus` - Up

Status of the package

`PatchDocument` - Up

A JSONPatch document as defined by RFC 6902

String The operation to be performed

Enum:

add

remove

replace

move

copy

test

path

String A JSON-Pointer

value (optional)

Object The value to be used within the operations.

from (optional)

String A string containing a JSON Pointer value.

`PatchRequest` - Up

A JSONPatch request

`Problem` - Up

A problem is defined by the description, has a known resolution and references to the affected catalogue items

id (optional)

UUID Unique ID of this problem. Assigned by server format: uuid

timestamp (optional)

Date Date and time when the problem was created. Assigned by server format: date-time

description

String Description of the problem

resolution

String Resolution of the problem

catalogueItemRefs

array[String] References to the affected catalogue items

`ProblemDetails` - Up

Problem and the related catalogue items

problem (optional)

Problem

catalogueItems (optional)

array[CatalogueItem]

`Problems` - Up

Lists of problems and their related catalogue items

problems (optional)

array[Problem]

catalogueItems (optional)

array[CatalogueItem]

`WhiteList` - Up

id (optional)

String Unique ID of this white-list. Assigned by server

buyer

String A reference to the party/organization for which this white-list is relevant. Pattern should be used ^((http[s]?):/)?/?([^:/\s]+)((/\w+)/)([\w-.]+[^#?\s]+)(.)?(#[\w-]+)?$

item (optional)

String Reference to catalogue item which are available to buyer for ordering.

`DeviceModel` - Up

id (optional)

String Unique ID of this catalogue item.

catalogueItemType

String Type discriminator. Legal values are "DeviceModel" and "Service".

identifiers (optional)

array[Identifier] Identifiers to connect CatalogueItem to external content available in other frameworks or protocols.

relatedTo (optional)

String Reference to related catalog item.

catalogue

String Reference to catalog, this item belongs to.

name

String A human readable short headline describing this catalogue item.

description (optional)

String A human readable detailed of this catalogue item (markdown format supported).

status

CatalogueItemStatus

supersededBy (optional)

String Reference to another catalogue item which supersedes this one.

manufacturer (optional)

String Name of the device manufacturer.

model (optional)

String The "model" is an identifier assigned by the manufacturer to identify the product by its type.

version (optional)

String The version of the device, if the device has multiple releases under the same model.

`Service` - Up

id (optional)

String Unique ID of this catalogue item.

catalogueItemType

String Type discriminator. Legal values are "DeviceModel" and "Service".

identifiers (optional)

array[Identifier] Identifiers to connect CatalogueItem to external content available in other frameworks or protocols.

relatedTo (optional)

String Reference to related catalog item.

catalogue

String Reference to catalog, this item belongs to.

name

String A human readable short headline describing this catalogue item.

description (optional)

String A human readable detailed of this catalogue item (markdown format supported).

status

CatalogueItemStatus

supersededBy (optional)

String Reference to another catalogue item which supersedes this one.

serviceType (optional)

Coding

eHealth SSL Catalogue service

Access

Table of Contents

Consumes

Request body

Responses

201

400

500

default

Path parameters

Responses

204

400

500

default

Query parameters

Return type

Example data

Produces

Responses

200

400

500

default

Consumes

Request body

Responses

204

400

500

default

Consumes

Request body

Responses

201

400

500

default

Path parameters

Responses

204

400

500

default

Path parameters

Return type

Example data

Produces

Responses

200

400

404

500

default

Query parameters

Return type

Example data

Produces

Responses

200

400

500

default

Consumes

Request body

Responses

201

400

500

default

Path parameters

Return type

Example data

Produces

Responses

200

404

default

Path parameters