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.
These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.
| 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 | Cardinality | Description |
|---|---|---|---|
id | string | 0..1 | Logical id of this artifact |
meta | Meta | 0..1 | Metadata about the resource |
implicitRules | uri | 0..1 | A set of rules under which this content was created |
language | code | 0..1 | Language of the resource content |
text | Narrative | 0..1 | Text summary of the resource, for human interpretation |
contained | Resource | 0..* | Contained, inline Resources |
extension | Extension | 0..* | Additional content defined by implementations |
modifierExtension | Extension | 0..* | Extensions that cannot be ignored |
identifier | Identifier | 0..* | Identifies this endpoint across multiple systems |
status | code | 1..1 | active | suspended | error | off | entered-in-error | test |
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 |
|---|---|---|
connection-type | token | Protocol/Profile/Standard to be used with this endpoint connection |
identifier | token | Identifies this endpoint across multiple systems |
name | string | A name that this endpoint can be identified by |
organization | reference | The organization that is managing the endpoint |
payload-type | token | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) |
status | token | The current status of the Endpoint (usually expected to be active) |
Reference
Official FHIR R4 spec: Endpoint.
Maturity: Trial Use 2 (FMM 2).