Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

Capability One First Use Case

First use case.

Use Case

TODO

Security

  • TODO

Prerequisites

Consumer

The Consumer system:

  • SHALL TODO.

API Usage

Request Operation

FHIR Relative Request

POST /TODO

FHIR Absolute Request

POST https://[proxy_server]/https://[provider_server]/[fhir_base]/TODO

Request Headers

Consumers SHALL include the following additional HTTP request headers:

Header Value
SSP-TraceID Consumer’s TraceID (i.e. GUID/UUID)
SSP-From Consumer’s ASID
SSP-To Provider’s ASID
SSP-InteractionID urn:nhs:names:services:TODO

Example HTTP request headers:

Connection: Keep-Alive

Payload Request Body

The following data-elements are mandatory (i.e. data MUST be present):

  • TODO

The following data-elements are optional (i.e. data MAY be supplied):

  • TODO
<OperationDefinition xmlns="http://hl7.org/fhir">
</OperationDefinition>
{
}

The Provider system SHALL:

  • TODO

Error Handling

The Provider system SHALL return an error if:

  • TODO

Request Response

Response Headers

HTTP/1.1 200 OK

Payload Response Body

Provider systems:

  • SHALL TODO.
{
}

Examples

C#

TODO

Java

TODO

Tags: fhir

All content is available under the Open Government Licence v3.0, except where otherwise stated