eHealth SSL Order service
eHealth SSL Order service
Version: 1.0.0
BasePath:/v1
Proprietary
http://apache.org/licenses/LICENSE-2.0.html
Access
- APIKey KeyParamName:Authorization KeyInQuery:false KeyInHeader:true
[ Jump to Models ]
Table of Contents
Create new Contract (createContract)
Create new Contract
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Contract which should be created
Responses
201
The Contract 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
Return Contract by id (getContractById)
Return Contract by id
Path parameters
id (required)
Path Parameter — Id of Contract
Return type
Example data
Content-Type: application/json
{
"validityPeriod" : {
"start" : "2019-01-01",
"end" : "2020-01-01"
},
"seller" : "http://ehealth.sundhed.dk/ssl-governance/v1/party/456",
"reminderDays" : 30,
"name" : "XYZ Supplier 2019-21 for Mainland area",
"id" : "2",
"account" : "http://ehealth.sundhed.dk/ssl-governance/v1/party/457",
"buyer" : [ "http://ehealth.sundhed.dk/ssl-governance/v1/party/458", "http://ehealth.sundhed.dk/ssl-governance/v1/party/459" ]
}
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 Contract was successfully returned
Contract
400
Invalid input
Error
404
Contract not found
Error
500
The server encountered an unexpected condition which prevented it from fulfilling the request
Error
default
Unexpected error
Error
Search for Contracts by parameters (getContracts)
Search for Contracts by parameters
Query parameters
seller (optional)
Query Parameter — Single seller reference can be provided
account (optional)
Query Parameter — Single account reference can be provided
buyer (optional)
Query Parameter — Single buyer reference can be provided
Return type
Example data
Content-Type: application/json
[ {
"validityPeriod" : {
"start" : "2019-01-01",
"end" : "2020-01-01"
},
"seller" : "http://ehealth.sundhed.dk/ssl-governance/v1/party/456",
"reminderDays" : 30,
"name" : "XYZ Supplier 2019-21 for Mainland area",
"id" : "2",
"account" : "http://ehealth.sundhed.dk/ssl-governance/v1/party/457",
"buyer" : [ "http://ehealth.sundhed.dk/ssl-governance/v1/party/458", "http://ehealth.sundhed.dk/ssl-governance/v1/party/459" ]
}, {
"validityPeriod" : {
"start" : "2019-01-01",
"end" : "2020-01-01"
},
"seller" : "http://ehealth.sundhed.dk/ssl-governance/v1/party/456",
"reminderDays" : 30,
"name" : "XYZ Supplier 2019-21 for Mainland area",
"id" : "2",
"account" : "http://ehealth.sundhed.dk/ssl-governance/v1/party/457",
"buyer" : [ "http://ehealth.sundhed.dk/ssl-governance/v1/party/458", "http://ehealth.sundhed.dk/ssl-governance/v1/party/459" ]
} ]
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 Contracts 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
Up
get /custom/hasValidContract
Check if a valid contract exists between the two parties (hasValidContract)
Check if a valid contract exists between the two parties
Query parameters
seller (required)
Query Parameter — Single seller reference can be provided, e.g. "http://ssl-order.ehealth.sundhed.dk/v1/party/b83e7b2e-779f-44fc-9c4d-b1f564303a31"
buyer (required)
Query Parameter — Single buyer reference can be provided, e.g. "https://ssl-order.ehealth.sundhed.dk/v1/party/d36202ed-4751-449b-a371-53a94b6b3ca4"
Return type
Boolean
Example data
Content-Type: application/json
true
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
Boolean {body} = true if valid contract between seller and buyer exists, and body = {false} if no contract
Boolean
400
Invalid input
Error
500
The server encountered an unexpected condition which prevented it from fulfilling the request
Error
default
Unexpected error
Error
Patch selected fields of the given contract (patchContract)
Patch selected fields of the given contract
Path parameters
id (required)
Path Parameter — Id of Contract format: uuid
Consumes
This API call consumes the following media types via the request header:
application/json-patch+json
Request body
Body Parameter — The JSON patch object
Responses
204
The contract was successfully updated.
400
Invalid input
Error
404
The contract was not found
Error
500
The server encountered an unexpected condition which prevented it from fulfilling the request
Error
Create a new order. (createOrder)
Consumes
This API call consumes the following media types via the request header:
Request body
Responses
201
The order 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 note for the order. (createOrderNote)
Path parameters
id (required)
Path Parameter — the id of the order notes to retrieve
Request body
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
204
The OrderNotes was successfully added to order.
400
The request could not be understood
Error
401
Unauthorized
Error
500
The server encountered an unexpected condition which prevented it from fulfilling the request.
Error
default
Unexpected error
Error
Delete an order (deleteOrder)
Path parameters
id (required)
Path Parameter — The id of the order to delete.
Responses
204
The order was successfully deleted.
400
The request could not be understood
Error
401
Unauthorized
Error
403
Order is not in state suitable for deletion.
Error
500
The server encountered an unexpected condition which prevented it from fulfilling the request.
Error
default
Unexpected error
Error
Retrieve an order (getOrderById)
Path parameters
id (required)
Path Parameter — The id of the order to retrieve.
Return type
Example data
Content-Type: application/json
""
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 order was successfully retrieved.
Order
400
The request could not be understood
Error
401
Unauthorized
Error
500
The server encountered an unexpected condition which prevented it from fulfilling the request.
Error
default
Unexpected error
Error
Up
get /order/{id}/details
Retrieve details of an order. (getOrderDetails)
Path parameters
id (required)
Path Parameter — The id of the order details to retrieve.
Return type
Example data
Content-Type: application/json
{
"orderLines" : [ {
"item" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue-item/14",
"agreedFrom" : "2020-01-01T00:00:00Z",
"agreedTo" : "2020-01-01T00:00:00Z",
"id" : "id",
"device" : {
"identifiers" : [ {
"system" : "urn:ietf:rfc:3986",
"assigner" : "Danish Health Authorities",
"value" : "NUC8766"
}, {
"system" : "urn:ietf:rfc:3986",
"assigner" : "Danish Health Authorities",
"value" : "NUC8766"
} ],
"clinicalRef" : "https://ehealth.sundhed.dk/device/fhir/Device/1566241",
"externalId" : "externalId"
},
"order" : "https://ssl-order.ehealth.sundhed.dk/v1/order/21",
"status" : { }
}, {
"item" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue-item/14",
"agreedFrom" : "2020-01-01T00:00:00Z",
"agreedTo" : "2020-01-01T00:00:00Z",
"id" : "id",
"device" : {
"identifiers" : [ {
"system" : "urn:ietf:rfc:3986",
"assigner" : "Danish Health Authorities",
"value" : "NUC8766"
}, {
"system" : "urn:ietf:rfc:3986",
"assigner" : "Danish Health Authorities",
"value" : "NUC8766"
} ],
"clinicalRef" : "https://ehealth.sundhed.dk/device/fhir/Device/1566241",
"externalId" : "externalId"
},
"order" : "https://ssl-order.ehealth.sundhed.dk/v1/order/21",
"status" : { }
} ],
"order" : "",
"traceLines" : [ {
"supplementaryText" : "supplementaryText",
"statusChange" : {
"newStatus" : "newStatus",
"oldStatus" : "oldStatus"
},
"createdByUser" : "createdByUser",
"orderLine" : "https://ssl-order.ehealth.sundhed.dk/v1/order-line/21",
"id" : "id",
"text" : "text",
"createdByOrganization" : "createdByOrganization",
"timestamp" : "2020-01-01T00:00:00Z",
"order" : "https://ssl-order.ehealth.sundhed.dk/v1/order/21"
}, {
"supplementaryText" : "supplementaryText",
"statusChange" : {
"newStatus" : "newStatus",
"oldStatus" : "oldStatus"
},
"createdByUser" : "createdByUser",
"orderLine" : "https://ssl-order.ehealth.sundhed.dk/v1/order-line/21",
"id" : "id",
"text" : "text",
"createdByOrganization" : "createdByOrganization",
"timestamp" : "2020-01-01T00:00:00Z",
"order" : "https://ssl-order.ehealth.sundhed.dk/v1/order/21"
} ]
}
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 order details were successfully retrieved.
OrderDetails
400
The request could not be understood
Error
401
Unauthorized
Error
500
The server encountered an unexpected condition which prevented it from fulfilling the request.
Error
default
Unexpected error
Error
Search orders by parameters (getOrders)
Query parameters
seller (optional)
Query Parameter — Multiple references to SellerSupplierParty can be provided.
buyer (optional)
Query Parameter — Multiple references to BuyerCustomerParty can be provided.
identifier (optional)
Query Parameter — Multiple identifier values like http://ehealth.xxx.dk/somesystem|somecode can be provided.
patient (optional)
Query Parameter — Multiple patient refernces from clinical domain can be provided.
Return type
Example data
Content-Type: application/json
[ "", "" ]
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
Orders were successfully retrieved.
400
The request could not be understood
Error
401
Unauthorized
Error
500
The server encountered an unexpected condition which prevented it from fulfilling the request.
Error
default
Unexpected error
Error
Up
get /system/hasOpenOrder
Check if an open order exists for the careplan (hasOpenOrder)
Check if an open order exists for the careplan
Query parameters
careplan (required)
Query Parameter — Single careplan reference can be provided
Return type
Boolean
Example data
Content-Type: application/json
true
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
Boolean {body} = true if an open order exists for the careplan exists, and body = {false} if no order or status is not open
Boolean
400
Invalid input
Error
500
The server encountered an unexpected condition which prevented it from fulfilling the request
Error
Update an order. (updateOrder)
id property is required.
Consumes
This API call consumes the following media types via the request header:
Request body
Responses
204
The order was successfully updated.
400
The request could not be understood.
Error
401
User is unauthorized to change field.
Error
403
Ilegal state changes are attempted.
Error
500
The server encountered an unexpected condition which prevented it from fulfilling the request.
Error
default
Unexpected error
Error
Update an order partially (updatedPartialOrder)
Path parameters
id (required)
Path Parameter — The id of the order to update partially.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The data of order to update partially.
Responses
204
The order was successfully updated.
400
The request could not be understood
Error
401
Unauthorized
Error
403
Illegal state changes are attempted.
Error
500
The server encountered an unexpected condition which prevented it from fulfilling the request.
Error
default
Unexpected error
Error
Create a new order line. (createOrderLine)
Consumes
This API call consumes the following media types via the request header:
Request body
Responses
201
The order line 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 order lines (createOrderLines)
Consumes
This API call consumes the following media types via the request header:
Request body
Responses
201
The order lines were successfully created.
400
The request could not be understood.
Error
401
Unauthorized.
Error
500
The server encountered an unexpected condition which prevented it from fulfilling the request.
Error
default
Unexpected error
Error
Up
delete /order-line/{id}
Delete an order line (deleteOrderLine)
Path parameters
id (required)
Path Parameter — The id of the order line to delete.
Responses
204
The order line was successfully deleted.
400
The request could not be understood
Error
401
Unauthorized
Error
403
Order line is not in state suitable for deletion.
Error
500
The server encountered an unexpected condition which prevented it from fulfilling the request.
Error
default
Unexpected error
Error
Retrieve an order line (getOrderLineById)
Path parameters
id (required)
Path Parameter — The id of the order line to retrieve.
Return type
Example data
Content-Type: application/json
{
"item" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue-item/14",
"agreedFrom" : "2020-01-01T00:00:00Z",
"agreedTo" : "2020-01-01T00:00:00Z",
"id" : "id",
"device" : {
"identifiers" : [ {
"system" : "urn:ietf:rfc:3986",
"assigner" : "Danish Health Authorities",
"value" : "NUC8766"
}, {
"system" : "urn:ietf:rfc:3986",
"assigner" : "Danish Health Authorities",
"value" : "NUC8766"
} ],
"clinicalRef" : "https://ehealth.sundhed.dk/device/fhir/Device/1566241",
"externalId" : "externalId"
},
"order" : "https://ssl-order.ehealth.sundhed.dk/v1/order/21",
"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 order line was successfully retrieved.
OrderLine
400
The request could not be understood
Error
401
Unauthorized
Error
500
The server encountered an unexpected condition which prevented it from fulfilling the request.
Error
default
Unexpected error
Error
Search order lines by parameters (getOrderLines)
Query parameters
order (optional)
Query Parameter — Multiple references to Order can be provided.
Return type
Example data
Content-Type: application/json
[ {
"item" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue-item/14",
"agreedFrom" : "2020-01-01T00:00:00Z",
"agreedTo" : "2020-01-01T00:00:00Z",
"id" : "id",
"device" : {
"identifiers" : [ {
"system" : "urn:ietf:rfc:3986",
"assigner" : "Danish Health Authorities",
"value" : "NUC8766"
}, {
"system" : "urn:ietf:rfc:3986",
"assigner" : "Danish Health Authorities",
"value" : "NUC8766"
} ],
"clinicalRef" : "https://ehealth.sundhed.dk/device/fhir/Device/1566241",
"externalId" : "externalId"
},
"order" : "https://ssl-order.ehealth.sundhed.dk/v1/order/21",
"status" : { }
}, {
"item" : "https://ssl-catalogue.ehealth.sundhed.dk/v1/catalogue-item/14",
"agreedFrom" : "2020-01-01T00:00:00Z",
"agreedTo" : "2020-01-01T00:00:00Z",
"id" : "id",
"device" : {
"identifiers" : [ {
"system" : "urn:ietf:rfc:3986",
"assigner" : "Danish Health Authorities",
"value" : "NUC8766"
}, {
"system" : "urn:ietf:rfc:3986",
"assigner" : "Danish Health Authorities",
"value" : "NUC8766"
} ],
"clinicalRef" : "https://ehealth.sundhed.dk/device/fhir/Device/1566241",
"externalId" : "externalId"
},
"order" : "https://ssl-order.ehealth.sundhed.dk/v1/order/21",
"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
Order lines were successfully retrieved.
400
The request could not be understood
Error
401
Unauthorized
Error
500
The server encountered an unexpected condition which prevented it from fulfilling the request.
Error
default
Unexpected error
Error
Up
patch /order-line/{id}
Patch the selected fields for a given order line (patchOrderLine)
Patch the selected fields for a given order line
Path parameters
id (required)
Path Parameter — Id of the order line format: string
Consumes
This API call consumes the following media types via the request header:
application/json-patch+json
Request body
Body Parameter — The JSON patch object
Responses
204
The order line was successfully updated.
400
Invalid input
Error
404
The order line was not found
Error
500
The server encountered an unexpected condition which prevented it from fulfilling the request
Error
Update an order line. (updateOrderLine)
id property is required.
Consumes
This API call consumes the following media types via the request header:
Request body
Responses
204
The order line was successfully updated.
400
The request could not be understood.
Error
401
User is unauthorized to change field.
Error
403
Ilegal state changes are attempted.
Error
500
The server encountered an unexpected condition which prevented it from fulfilling the request.
Error
default
Unexpected error
Error
Update existing order lines (updateOrderLines)
Consumes
This API call consumes the following media types via the request header:
Request body
Responses
204
Order lines were successfully updated.
400
The request could not be understood.
Error
401
Unauthorized.
Error
403
Illegal state changes are attempted.
Error
500
The server encountered an unexpected condition which prevented it from fulfilling the request.
Error
default
Unexpected error
Error
Create new Party (createParty)
Create new Party
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Party which should be created.
Responses
201
The Party 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
post /custom/findOrCreateParty
Find or create Party for given organizationReference (findOrCreatePartyMethod)
This operation will search for a Party having the given organizationReference.
If no Party is found a Party will be created referencing the given organizationReference and a list of allowedRoles depending on the user type supplied in the authentication token:
- UserType PRACITIONER, allowedRoles: BUYER, ACCOUNTING
- UserType SSL, allowedRoles: SELLER
The given organizationReference must match the organization context supplied in the authentication token.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — OrganizationReference of the Party
Responses
201
The Party was successfully found or created
400
Invalid input
Error
500
The server encountered an unexpected condition which prevented it from fulfilling the request
Error
default
Unexpected error
Error
Search parties by parameters (getParties)
Search parties by parameters
Query parameters
name (optional)
Query Parameter — Multiple name values can be provided
role (optional)
Query Parameter — Multiple role values can be provided
Return type
Example data
Content-Type: application/json
[ {
"allowedRoles" : [ "BUYER", "ACCOUNTING" ],
"organization" : "https://ehealth.sundhed.dk/organization/fhir/Organization/1566241",
"name" : "Aarhus University Hospital",
"id" : "1",
"email" : "auh@rm.dk"
}, {
"allowedRoles" : [ "BUYER", "ACCOUNTING" ],
"organization" : "https://ehealth.sundhed.dk/organization/fhir/Organization/1566241",
"name" : "Aarhus University Hospital",
"id" : "1",
"email" : "auh@rm.dk"
} ]
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 Parties 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
Return Party by id (getPartyById)
Return Party by id
Path parameters
id (required)
Path Parameter — Id of Party
Return type
Example data
Content-Type: application/json
{
"allowedRoles" : [ "BUYER", "ACCOUNTING" ],
"organization" : "https://ehealth.sundhed.dk/organization/fhir/Organization/1566241",
"name" : "Aarhus University Hospital",
"id" : "1",
"email" : "auh@rm.dk"
}
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 Party was successfully returned
Party
400
Invalid input
Error
404
Party not found
Error
500
The server encountered an unexpected condition which prevented it from fulfilling the request
Error
default
Unexpected error
Error
Up
post /system/findOrCreateParty
Find or create Party for given organizationReference (systemFindOrCreatePartyMethod)
This is a infrastructure-only operation that will search for a Party having the given organizationReference.
If no Party is found a Party will be created referencing the given organizationReference and an empty list of allowedRoles.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — OrganizationReference of the Party
Responses
201
The Party was successfully found or created
400
Invalid input
Error
500
The server encountered an unexpected condition which prevented it from fulfilling the request
Error
default
Unexpected error
Error
Update Party (updateParty)
Update Party
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Party with data to update
Responses
204
The Party was successfully updated
400
Invalid input
Error
404
Party not found
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
Coding - Contract - Contract_validityPeriod - Error - Identifier - OrderBase - OrderDetails - OrderLine - OrderLineStatus - OrderLine_device - OrderNotes - OrderReceiver - OrderStatus - OrganizationReference - Party - PatchDocument - PatchRequest - StatusChange - TraceLine - Order -
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
id (optional)
String Unique ID of this contract. Assigned by server
name (optional)
String A human readable short headline describing this contract.
validityPeriod
seller
String Reference (by rest url) to the SSL service provider
account
String Reference (by rest url) to the healthcare organisation responsible for paying for services. Typically this will be a high level organisation like a region or municipality
buyer (optional)
array[String] References (by rest url) to the healthcare organisations ordering services. A contract can support multiple buyers (e.g. different hospitals or departments)
reminderDays (optional)
Integer Default number of days before an appointment with a patient where a reminder should be sent format: int32
Period where this contract is valid
start
date Start Date for this time period format: date
end (optional)
date Last day of contract validity period format: date
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 Globally unique ID of this order. Assigned by server.
threadId (optional)
String Thread id for ehealth-messages for this order.
identifiers (optional)
array[Identifier] Identifiers to connect Order to external content available in other frameworks or protocols.
status (optional)
priority (optional)
Boolean Shows if this order has high priority.
notes (optional)
array[OrderNotes] Notes attached to the order by buyer or seller. These are intended to contain remarks or details about the fulfilment of the order
buyer (optional)
String Reference to BuyerCustomerParty on behalf of which this order is placed.
seller (optional)
String Reference to SellerSupplierParty which is responsible for supplying the items required to fulfil this order.
sellerDeliveryContactEmail (optional)
carePlanRef (optional)
carePlanTitle (optional)
String The title of the careplan. Automatically filled by the system based on carePlanRef.
earliestDeliveryDate (optional)
date Earliest delivery date of order. Automatically filled by the system based on the agreed time of unfulfilled order lines. format: date
latestDeliveryDate (optional)
date Latest delivery date of order. Automatically filled by the system based on the agreed time of unfulfilled order lines. format: date
receiver (optional)
An order details represent all information about order, order lines and trace lines related to this order.
order
orderLines (optional)
traceLines (optional)
An order represents a request for items and services to be delivered to a recipient. The order is placed by a practioner and executed by a provider.
id (optional)
String Globally unique ID of this order item. Assigned by server
order
String Reference to order to which this order line belongs
status
item (optional)
String Reference to ordered catalog item
agreedFrom
Date The agreed from is a time agreed between the seller and the receiver as the earliest date for next delivery or pickup attempt or shipment to be made. format: date-time
agreedTo
Date The agreed to is a time agreedbetween the seller and the receiver as the latest date for the next delivery or pickup attempt or shipment to be made. format: date-time
device (optional)
The actual device to be delivered or picked up. Only relevant when the fulfilment involves an actual device (opposed to delivery of a service).
externalId (optional)
String External id of the device
identifiers (optional)
array[Identifier] Identifiers to connect Device instance to external content available in other frameworks or protocols.
clinicalRef (optional)
String A reference to the corresponding Device resource in the FHIR-based clinical backend.
Notes attached to the order by buyer or seller. These are intended to contain remarks or details about the fulfilment of the order
timestamp (optional)
authorName (optional)
authorOrganization (optional)
text
Contact information of the recipient to whom the items and services in this order are to be delivered or picked-up.
name (optional)
addressLine1 (optional)
addressLine2 (optional)
postalCode (optional)
postalDistrict (optional)
email (optional)
phone (optional)
patient (optional)
String Reference to the corresponding ehealth-patient in the clinical domain. Pattern should be used - ^(?:http(s)?://)?[\w.-]+(?:.[\w.-]+)+[\w-._~:/?#[]@!$&'()*+,;=.]+/Patient/\d+$
OrganizationReference contains a reference to an organization.
organizationReference
String Reference to Organization.
id (optional)
String Unique ID of this Party. Assigned by server
allowedRoles
name
email (optional)
String Party contact person email format: email
organization (optional)
String Reference to the corresponding ehealth-organisation in the clinical domain. Pattern should be used ^(?:http(s)?://)?[\w.-]+(?:.[\w.-]+)+[\w-._~:/?#[]@!$&'()*+,;=.]+/Organization/\d+$
A JSONPatch document as defined by RFC 6902
op
String The operation to be performed
add
remove
replace
move
copy
test
path
value (optional)
Object The value to be used within the operations.
from (optional)
String A string containing a JSON Pointer value.
StatusChange represents changes of status for order or order line.
oldStatus
String Status of the resource immediately prior to the event which triggered this TraceLine.
newStatus
String Status of the resource immediately after to the event which triggered this TraceLine.
A trace line documents a single atomic business event related to an order and optionally a number of order lines.
id (optional)
String Globally unique ID of this order item. Assigned by server
timestamp (optional)
Date Date and time at which this trace line was created. format: date-time
createdByOrganization
String The name of the organization which created or directly caused this trace line.
createdByUser (optional)
String The name of the user which created or directly caused this trace line.
text
String A Danish-language human-readable text lines carrying the a description of what triggered this trace line.
supplementaryText (optional)
String A supplementary Danish-language human-readable text lines carrying the a description of what triggered this trace line.
order
String Reference to Order to which this trace line is related.
orderLine (optional)
String Reference to order line to which this trace line is related.
statusChange (optional)
An order represents a request for items and services to be delivered to a recipient. The order is placed by a practioner and executed by a provider.
id (optional)
String Globally unique ID of this order. Assigned by server.
threadId (optional)
String Thread id for ehealth-messages for this order.
identifiers (optional)
array[Identifier] Identifiers to connect Order to external content available in other frameworks or protocols.
status (optional)
priority (optional)
Boolean Shows if this order has high priority.
notes (optional)
array[OrderNotes] Notes attached to the order by buyer or seller. These are intended to contain remarks or details about the fulfilment of the order
buyer (optional)
String Reference to BuyerCustomerParty on behalf of which this order is placed.
seller (optional)
String Reference to SellerSupplierParty which is responsible for supplying the items required to fulfil this order.
sellerDeliveryContactEmail (optional)
carePlanRef (optional)
carePlanTitle (optional)
String The title of the careplan. Automatically filled by the system based on carePlanRef.
earliestDeliveryDate (optional)
date Earliest delivery date of order. Automatically filled by the system based on the agreed time of unfulfilled order lines. format: date
latestDeliveryDate (optional)
date Latest delivery date of order. Automatically filled by the system based on the agreed time of unfulfilled order lines. format: date
receiver (optional)