endpoints

post

/organizations/{organizationId}/fhir/3/endpoint

The technical details of an endpoint that can be used for electronic services, such as for web services providing XDS.b or a REST endpoint for another FHIR server. This may include any security context information.

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	Endpoint	This is a Endpoint resource
identifier	array(Identifier)		Identifier for the organization that is used to identify the endpoint across multiple disparate systems.
status	string	active\|suspended\|error\|off\|entered-in-error\|test	active \| suspended \| error \| off \| test.
connectionType*	Coding		A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook).
name	string		A friendly name that this endpoint can be referred to with.
managingOrganization	Reference		The organization that manages this endpoint (even if technically another organisation is hosting this in the cloud, it is the organisation associated with the data).
contact	array(ContactPoint)		Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.
period	Period		The interval during which the endpoint is expected to be operational.
payloadType*	array(CodeableConcept)		The payload type describes the acceptable content that can be communicated on the endpoint.
payloadMimeType	array()		The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json. If the mime type is not specified, then the sender could send any content (including no content depending on the connectionType).
address	string		The uri that describes the actual end-point to connect to.
header	array()		Additional headers / information to send as part of the notification.

Response

200 400 401 404

patch

/organizations/{organizationId}/fhir/3/endpoint/{resourceId}

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*	string	Endpoint	This is a Endpoint resource
identifier	array(Identifier)		Identifier for the organization that is used to identify the endpoint across multiple disparate systems.
status	string	active\|suspended\|error\|off\|entered-in-error\|test	active \| suspended \| error \| off \| test.
connectionType*	Coding		A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook).
name	string		A friendly name that this endpoint can be referred to with.
managingOrganization	Reference		The organization that manages this endpoint (even if technically another organisation is hosting this in the cloud, it is the organisation associated with the data).
contact	array(ContactPoint)		Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.
period	Period		The interval during which the endpoint is expected to be operational.
payloadType*	array(CodeableConcept)		The payload type describes the acceptable content that can be communicated on the endpoint.
payloadMimeType	array()		The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json. If the mime type is not specified, then the sender could send any content (including no content depending on the connectionType).
address	string		The uri that describes the actual end-point to connect to.
header	array()		Additional headers / information to send as part of the notification.

Response

200 400 401 404

get

/organizations/{organizationId}/fhir/3/endpoint/{resourceId}

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 400 401 404

get

/organizations/{organizationId}/fhir/3/endpoint/{resourceId}/_history

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 400 401 404

get

/organizations/{organizationId}/fhir/3/endpoint/{resourceId}/_history/{versionId}

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params

Params


organizationId*	string\|string	id\|slug
resourceId*
versionId*

Response

200 400 401 404

delete

/organizations/{organizationId}/fhir/3/endpoint/{resourceId}

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 400 401 404

get

/organizations/{organizationId}/fhir/3/endpoint

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string
connection-type	string
identifier	string
name	string
organization	string
payload-type	string
status	string

Params


organizationId*	string\|string		id\|slug

Response

200 400 401 404

get

/organizations/{organizationId}/fhir/3/endpoint/_history

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug

Response

200 400 401 404

post

/organizations/{organizationId}/fhir/3/endpoint/_search

Request

Headers


content-type*	string	application/json\|application/x-www-form-urlencoded	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string
connection-type	string
identifier	string
name	string
organization	string
payload-type	string
status	string

Params


organizationId*	string\|string		id\|slug

Body


resourceType*	string	Endpoint	This is a Endpoint resource
identifier	array(Identifier)		Identifier for the organization that is used to identify the endpoint across multiple disparate systems.
status	string	active\|suspended\|error\|off\|entered-in-error\|test	active \| suspended \| error \| off \| test.
connectionType*	Coding		A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook).
name	string		A friendly name that this endpoint can be referred to with.
managingOrganization	Reference		The organization that manages this endpoint (even if technically another organisation is hosting this in the cloud, it is the organisation associated with the data).
contact	array(ContactPoint)		Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.
period	Period		The interval during which the endpoint is expected to be operational.
payloadType*	array(CodeableConcept)		The payload type describes the acceptable content that can be communicated on the endpoint.
payloadMimeType	array()		The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json. If the mime type is not specified, then the sender could send any content (including no content depending on the connectionType).
address	string		The uri that describes the actual end-point to connect to.
header	array()		Additional headers / information to send as part of the notification.

Response

200 400 401 404

put

/organizations/{organizationId}/fhir/3/endpoint/{resourceId}

Request

Headers


content-type*	string	application/json	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*	string	Endpoint	This is a Endpoint resource
identifier	array(Identifier)		Identifier for the organization that is used to identify the endpoint across multiple disparate systems.
status	string	active\|suspended\|error\|off\|entered-in-error\|test	active \| suspended \| error \| off \| test.
connectionType*	Coding		A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook).
name	string		A friendly name that this endpoint can be referred to with.
managingOrganization	Reference		The organization that manages this endpoint (even if technically another organisation is hosting this in the cloud, it is the organisation associated with the data).
contact	array(ContactPoint)		Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.
period	Period		The interval during which the endpoint is expected to be operational.
payloadType*	array(CodeableConcept)		The payload type describes the acceptable content that can be communicated on the endpoint.
payloadMimeType	array()		The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json. If the mime type is not specified, then the sender could send any content (including no content depending on the connectionType).
address	string		The uri that describes the actual end-point to connect to.
header	array()		Additional headers / information to send as part of the notification.

Response

200 400 401 404