eHealth SSL Catalogue service
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
Version: 1.0.0
BasePath:/v1
Proprietary
http://apache.org/licenses/LICENSE-2.0.html
Access
[ Jump to Models ]
Table of Contents
Create a new Annotation. (createAnnotation)
Consumes
This API call consumes the following media types via the request header:
Request body
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
Up
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
List Annotations. (listAnnotations)
Query parameters
buyer (required)
Query Parameter — List Annotations related to this buyer
catalogueItem (required)
Query Parameter — List Annotations related to this CatalogueItem
Return type
Example data
Content-Type: application/json
[ {
"catalogueItem" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catelogue-item/4342",
"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/catelogue-item/4342",
"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.
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
Update an Annotation. (updateAnnotation)
id property is required.
Consumes
This API call consumes the following media types via the request header:
Request body
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
Create new black list (createBlackList)
Create new black list
Consumes
This API call consumes the following media types via the request header:
Request body
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
Up
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
Return black list by id (getBlackListById)
Return black list by id
Path parameters
id (required)
Path Parameter — Id of black list
Return type
Example data
Content-Type: application/json
{
"item" : "",
"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.
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
Search black lists by parameters (getBlackLists)
Search black list by parameters
Query parameters
patient (optional)
Query Parameter — Multiple patient in clinical domain refernce values can be provided
Return type
Example data
Content-Type: application/json
[ {
"item" : "",
"patient" : "https://ehealth.sundhed.dk/patient/fhir/Patient/1566241",
"id" : "3"
}, {
"item" : "",
"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.
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
Create a new Catalogue. (createCatalogue)
Consumes
This API call consumes the following media types via the request header:
Request body
Query parameters
matchCatalogueByIdentifier (optional)
Query 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 a Catalogue (getCatalogue)
Path parameters
id (required)
Path Parameter — The id of the Catalogue to get.
Return type
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.
Responses
200
The requested Catalogue was found.
Catalogue
404
Catalogue not found
Error
default
unexpected error
Error
List all catalogues. (listCatalogues)
Query parameters
seller (required)
Query Parameter —
Return type
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.
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
Update a Catalogue. (updateCatalogue)
id property is required.
Consumes
This API call consumes the following media types via the request header:
Request body
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
Create a new CatalogueItem. (createCatalogueItem)
Consumes
This API call consumes the following media types via the request header:
Request body
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
Create new CatalogueItems. (createCatalogueItems)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
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/device-model/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/device-model/99822",
"catalogue" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue/213",
"relatedTo" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue-item/11",
"status" : { }
} ]
Responses
201
The CatalogueItems were 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
Up
get /catalogue-item/{id}
Get a CatalogueItem (getCatalogueItem)
Path parameters
id (required)
Path Parameter — The id of the CatalogueItem to get.
Return type
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/device-model/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.
Responses
200
The requested CatalogueItem was found.
CatalogueItem
404
CatalogueItem not found
Error
default
unexpected error
Error
List all CatalogueItems. (listCatalogueItems)
Query parameters
catalogue (optional)
Query Parameter — List only CatalogueItems from this Catalogue
buyer (required)
Query Parameter — List matching CatalogueItems across all Catalogues available to this buyer.
patient (optional)
Query Parameter — Patient for which the CatalogueItems will be delivered. CatalogueItems should not be black-listed with the given stated Patient.
annotation (required)
Query Parameter — Matching CatalogueItems must be associated with all of the mentioned Annotation values. Example annotation=http://ehealth.sundhed.dk/vs/device-measuring-quality/low
Return type
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/device-model/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/device-model/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.
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
Update a CatalogueItem. (updateCatalogueItem)
id property is required.
Consumes
This API call consumes the following media types via the request header:
Request body
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
Create new white list (createWhiteList)
Create new white list
Consumes
This API call consumes the following media types via the request header:
Request body
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
Up
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
Return white list by id (getWhiteListById)
Return white list by id
Path parameters
id (required)
Path Parameter — Id of white list
Return type
Example data
Content-Type: application/json
{
"item" : "",
"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.
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
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
Example data
Content-Type: application/json
[ {
"item" : "",
"id" : "2",
"buyer" : "http://ssl-order.ehealth.sundhed.dk/v1/party/456"
}, {
"item" : "",
"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.
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
[ Jump to Methods ]
Table of Contents
Annotation - AnnotationStatus - BlackList - Catalogue - CatalogueItem - CatalogueItemStatus - CatalogueStatus - Coding - Error - Identifier - WhiteList - DeviceModel - Service -
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.
status (optional)
value (optional)
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 References to catalog items which were put in black list by patient and reasons why this items are in black list. Pattern should be used ^((http[s]?):/)?/?([^:/\s]+)((/\w+)
/)([\w-.]+[^#?\s]+)(.)?(#[\w-]+)?$
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
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 releted catalog item. Or can be number that points to index in the list of catalogue items.
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
supersededBy (optional)
String Refernce to another catalogue item which supersedes this one. Or can be number that points to index in the list of catalogue items.
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
An business process error reported by the server.
id
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
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)
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 relavant. Pattern should be used ^((http[s]?):/)?/?([^:/\s]+)((/\w+)
/)([\w-.]+[^#?\s]+)(.)?(#[\w-]+)?$
item (optional)
String References to CatalogueItems which are available to buyer for ordering.
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 releted catalog item. Or can be number that points to index in the list of catalogue items.
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
supersededBy (optional)
String Refernce to another catalogue item which supersedes this one. Or can be number that points to index in the list of catalogue items.
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.
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 releted catalog item. Or can be number that points to index in the list of catalogue items.
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
supersededBy (optional)
String Refernce to another catalogue item which supersedes this one. Or can be number that points to index in the list of catalogue items.
serviceType (optional)