Endpoint

ResourceBase · EntitiesTrial useMaturity 2

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.

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

6 of 6 parameters tested

Structure

Show inherited elements (8)

Element	Card.	Type	Description
identifierΣ	0..*	Identifier	Identifies this endpoint across multiple systems
statusRequired?!Σ	1..1	code	active | suspended | error | off | entered-in-error | testBinding (required): endpoint-status
connectionTypeRequiredΣ	1..1	Coding	Protocol/Profile/Standard to be used with this endpoint connectionBinding (extensible): endpoint-connection-type
nameΣ	0..1	string	A name that this endpoint can be identified by
managingOrganizationΣ	0..1	Reference(Organization)	Organization that manages this endpoint (might not be the organization that exposes the endpoint)
contact	0..*	ContactPoint	Contact details for source (e.g. troubleshooting)
periodΣ	0..1	Period	Interval the endpoint is expected to be operational
payloadTypeRequiredΣ	1..*	CodeableConcept	The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)Binding (example): endpoint-payload-type
payloadMimeTypeΣ	0..*	code	Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)Binding (required): mimetypes
addressRequiredΣ	1..1	url	The technical base address for connecting to this endpoint
header	0..*	string	Usage depends on the channel type

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters

Query with GET [base]/Endpoint?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameter	Type	Description	PG	ES
connection-type	token	Protocol/Profile/Standard to be used with this endpoint connection Endpoint.connectionType
identifier	token	Identifies this endpoint across multiple systems Endpoint.identifier
name	string	A name that this endpoint can be identified by Endpoint.name
organization	reference	The organization that is managing the endpoint Endpoint.managingOrganization
payload-type	token	The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Endpoint.payloadType
status	token	The current status of the Endpoint (usually expected to be active) Endpoint.status

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition