endpoints

Create Endpoint

post

/organizations/{organizationId}/fhir/4/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+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug

Body


resourceType*			This is a Endpoint resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules	uri		A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language	code		The base language in which the resource is written.
text	Narrative		A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained	array(ResourceList)		These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifier	array(Identifier)		Identifier for the organization that is used to identify the endpoint across multiple disparate systems.
status		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 organization is hosting this in the cloud, it is the organization 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(code)		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	url		The uri that describes the actual end-point to connect to.
header	array(string)		Additional headers / information to send as part of the notification.

Response

201 400 401 404

Patch Endpoint

patch

/organizations/{organizationId}/fhir/4/Endpoint/{resourceId}

Request

Headers


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

Params


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

Body


resourceType*			This is a Endpoint resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules	uri		A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language	code		The base language in which the resource is written.
text	Narrative		A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained	array(ResourceList)		These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifier	array(Identifier)		Identifier for the organization that is used to identify the endpoint across multiple disparate systems.
status		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 organization is hosting this in the cloud, it is the organization 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(code)		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	url		The uri that describes the actual end-point to connect to.
header	array(string)		Additional headers / information to send as part of the notification.

Response

200 201 400 401 404 409

Read Endpoint

get

/organizations/{organizationId}/fhir/4/Endpoint/{resourceId}

Request

Headers


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

Params


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

Response

200 401 404

Read History Endpoint

get

/organizations/{organizationId}/fhir/4/Endpoint/{resourceId}/_history

Request

Headers


content-type*	string	application/json\|application/json+fhir	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 401 404

Read Version Endpoint

get

/organizations/{organizationId}/fhir/4/Endpoint/{resourceId}/_history/{versionId}

Request

Headers


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

Params


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

Response

200 400 401 404

Remove Endpoint

delete

/organizations/{organizationId}/fhir/4/Endpoint/{resourceId}

Request

Headers


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

Params


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

Response

200 204 400 401 404 409

Search Get Endpoint

get

/organizations/{organizationId}/fhir/4/Endpoint

Request

Headers


content-type*	string	application/json\|application/json+fhir	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 401 404

Search History Endpoint

get

/organizations/{organizationId}/fhir/4/Endpoint/_history

Request

Headers


content-type*	string	application/json\|application/json+fhir	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 401 404

Search Post Endpoint

post

/organizations/{organizationId}/fhir/4/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*			This is a Endpoint resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules	uri		A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language	code		The base language in which the resource is written.
text	Narrative		A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained	array(ResourceList)		These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifier	array(Identifier)		Identifier for the organization that is used to identify the endpoint across multiple disparate systems.
status		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 organization is hosting this in the cloud, it is the organization 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(code)		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	url		The uri that describes the actual end-point to connect to.
header	array(string)		Additional headers / information to send as part of the notification.

Response

200 401 404

Update Endpoint

put

/organizations/{organizationId}/fhir/4/Endpoint/{resourceId}

Request

Headers


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

Params


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

Body


resourceType*			This is a Endpoint resource
id	id		The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta		The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules	uri		A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language	code		The base language in which the resource is written.
text	Narrative		A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained	array(ResourceList)		These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtension	array(Extension)		May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifier	array(Identifier)		Identifier for the organization that is used to identify the endpoint across multiple disparate systems.
status		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 organization is hosting this in the cloud, it is the organization 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(code)		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	url		The uri that describes the actual end-point to connect to.
header	array(string)		Additional headers / information to send as part of the notification.

Response

200 201 400 401 404 409