v1

latestOpenAPI 3.0.0Apache 2.02026-07-143533191.6 KB
Endpoint

Get the Endpoint templates based on Endpoint, ConnectionType and PayloadType identifiers

Get the Endpoint templates for an identifier. Its address will be omitted if the Endpoint.header is set to private, unless the requestor is the owner.

get/Endpoint/$template

Query parameters

Endpoint.identifierstring
Example:https://fhir.nhs.uk/Id/EndpointSystem|EndpointValue

The identifier of the type of Endpoint, usually the identifier set by the organisation/supplier that created the Endpoint. It is important to note that this is not the same as Endpoint.id, which is the unique identifier for the Endpoint resource. The Endpoint.identifier can be shared across multiple Endpoint resources. This needs to be URL Encoded as its passed as a query parameter and part of the URL.

ConnectionTypestring
Example:https%3A%2F%2Fterminology.hl7.org%2FCodeSystem%2Fendpoint-connection-type%7Chl7-fhir-rest

The URL encoded technical protocol used (e.g., hl7-fhir-rest). This needs to be URL Encoded as it is passed as a query parameter and part of the URL.

TypeExpression
tokenhl7-fhir-rest

Example before encoding https://terminology.hl7.org/CodeSystem/endpoint-connection-type|hl7-fhir-rest

PayloadTypestring
Example:https%3A%2F%2Fterminology.hl7.org%2FCodeSystem%2Fendpoint-payload-type%7Cbars

Defines the specific message standard used (e.g., BaRS).

The URL encoded specific message standard used (e.g., BaRS). This needs to be URL Encoded as it is passed as a query parameter and part of the URL.

TypeExpression
tokenbars

Example before encoding https://terminology.hl7.org/CodeSystem/endpoint-payload-type|bars

Response

The operation was successful