Endpoint

Trial Use 2 Base

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.

Endpoints

alphahttps://api.dev.ovok.com/fhir/R4/Endpoint

Interaction	Method	Path
Read	GET	/fhir/R4/Endpoint/[id]
Vread	GET	/fhir/R4/Endpoint/[id]/_history/[vid]
Update	PUT	/fhir/R4/Endpoint/[id]
Patch	PATCH	/fhir/R4/Endpoint/[id]
Delete	DELETE	/fhir/R4/Endpoint/[id]
Create	POST	/fhir/R4/Endpoint
Search	GET	/fhir/R4/Endpoint
History	GET	/fhir/R4/Endpoint/[id]/_history

Top-level elements

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

Resource-specific search parameters

Parameter	Type	Description
_compartment	string
_count	string	https://www.hl7.org/fhir/search.html#_count
_elements	string	https://www.hl7.org/fhir/search.html#_elements
_id	string
_lastUpdated	string
_profile	string
_security	string
_sort	string	https://www.hl7.org/fhir/search.html#_sort
_source	string
_summary	string	https://www.hl7.org/fhir/search.html#_summary
_tag	string
_total	string	https://www.hl7.org/fhir/search.html#_total
connection-type	string	http://hl7.org/fhir/SearchParameter/Endpoint-connection-type
identifier	string	http://hl7.org/fhir/SearchParameter/Endpoint-identifier
name	string	http://hl7.org/fhir/SearchParameter/Endpoint-name
organization	string	http://hl7.org/fhir/SearchParameter/Endpoint-organization
payload-type	string	http://hl7.org/fhir/SearchParameter/Endpoint-payload-type
status	string	http://hl7.org/fhir/SearchParameter/Endpoint-status

Reference

• Official FHIR R4 spec: Endpoint
• Maturity: Trial Use 2 (FMM 2).