endpoints

Create Endpoint

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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringEndpointThis is a Endpoint resource
identifierarray(Identifier)Identifier for the organization that is used to identify the endpoint across multiple disparate systems.
statusstringactive|suspended|error|off|entered-in-error|testactive | suspended | error | off | test.
connectionType*CodingA 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).
namestringA friendly name that this endpoint can be referred to with.
managingOrganizationReferenceThe organization that manages this endpoint (even if technically another organisation is hosting this in the cloud, it is the organisation associated with the data).
contactarray(ContactPoint)Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.
periodPeriodThe 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.
payloadMimeTypearray()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).
addressstringThe uri that describes the actual end-point to connect to.
headerarray()Additional headers / information to send as part of the notification.

Response

Patch Endpoint

patch
/organizations/{organizationId}/fhir/3/Endpoint/{resourceId}

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*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringEndpointThis is a Endpoint resource
identifierarray(Identifier)Identifier for the organization that is used to identify the endpoint across multiple disparate systems.
statusstringactive|suspended|error|off|entered-in-error|testactive | suspended | error | off | test.
connectionType*CodingA 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).
namestringA friendly name that this endpoint can be referred to with.
managingOrganizationReferenceThe organization that manages this endpoint (even if technically another organisation is hosting this in the cloud, it is the organisation associated with the data).
contactarray(ContactPoint)Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.
periodPeriodThe 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.
payloadMimeTypearray()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).
addressstringThe uri that describes the actual end-point to connect to.
headerarray()Additional headers / information to send as part of the notification.

Response

Read Endpoint

get
/organizations/{organizationId}/fhir/3/Endpoint/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Endpoint

get
/organizations/{organizationId}/fhir/3/Endpoint/{resourceId}/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Endpoint

get
/organizations/{organizationId}/fhir/3/Endpoint/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Endpoint

delete
/organizations/{organizationId}/fhir/3/Endpoint/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Endpoint

get
/organizations/{organizationId}/fhir/3/Endpoint

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
connection-typestring
identifierstring
namestring
organizationstring
payload-typestring
statusstring

Params

organizationId*string|stringid|slug

Response

Search History Endpoint

get
/organizations/{organizationId}/fhir/3/Endpoint/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post Endpoint

post
/organizations/{organizationId}/fhir/3/Endpoint/_search

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*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
connection-typestring
identifierstring
namestring
organizationstring
payload-typestring
statusstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringEndpointThis is a Endpoint resource
identifierarray(Identifier)Identifier for the organization that is used to identify the endpoint across multiple disparate systems.
statusstringactive|suspended|error|off|entered-in-error|testactive | suspended | error | off | test.
connectionType*CodingA 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).
namestringA friendly name that this endpoint can be referred to with.
managingOrganizationReferenceThe organization that manages this endpoint (even if technically another organisation is hosting this in the cloud, it is the organisation associated with the data).
contactarray(ContactPoint)Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.
periodPeriodThe 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.
payloadMimeTypearray()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).
addressstringThe uri that describes the actual end-point to connect to.
headerarray()Additional headers / information to send as part of the notification.

Response

Update Endpoint

put
/organizations/{organizationId}/fhir/3/Endpoint/{resourceId}

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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringEndpointThis is a Endpoint resource
identifierarray(Identifier)Identifier for the organization that is used to identify the endpoint across multiple disparate systems.
statusstringactive|suspended|error|off|entered-in-error|testactive | suspended | error | off | test.
connectionType*CodingA 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).
namestringA friendly name that this endpoint can be referred to with.
managingOrganizationReferenceThe organization that manages this endpoint (even if technically another organisation is hosting this in the cloud, it is the organisation associated with the data).
contactarray(ContactPoint)Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.
periodPeriodThe 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.
payloadMimeTypearray()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).
addressstringThe uri that describes the actual end-point to connect to.
headerarray()Additional headers / information to send as part of the notification.

Response