# Endpoint

Canonical page: https://docs.ovok.com/api/fhir/r4/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 [#top-level-elements]

| **Element** | **Type** | **Cardinality** | **Description** |
| --- | --- | --- | --- |
| <span id="element-id"></span>`id` | [string](/fhir-elements/primitive/string) | `0..1` | Logical id of this artifact |
| <span id="element-meta"></span>`meta` | [Meta](/fhir-elements/complex/meta) | `0..1` | Metadata about the resource |
| <span id="element-implicit-rules"></span>`implicitRules` | [uri](/fhir-elements/primitive/uri) | `0..1` | A set of rules under which this content was created |
| <span id="element-language"></span>`language` | [code](/fhir-elements/primitive/code) | `0..1` | Language of the resource content |
| <span id="element-text"></span>`text` | [Narrative](/fhir-elements/complex/narrative) | `0..1` | Text summary of the resource, for human interpretation |
| <span id="element-contained"></span>`contained` | [Resource](/fhir-elements/foundation/resource) | `0..*` | Contained, inline Resources |
| <span id="element-extension"></span>`extension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Additional content defined by implementations |
| <span id="element-modifier-extension"></span>`modifierExtension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Extensions that cannot be ignored |
| <span id="element-identifier"></span>`identifier` | [Identifier](/fhir-elements/complex/identifier) | `0..*` | Identifies this endpoint across multiple systems |
| <span id="element-status"></span>`status` | [code](/fhir-elements/primitive/code) | `1..1` | active \| suspended \| error \| off \| entered-in-error \| test |
| <span id="element-connection-type"></span>`connectionType` | [Coding](/fhir-elements/complex/coding) | `1..1` | Protocol/Profile/Standard to be used with this endpoint connection |
| <span id="element-name"></span>`name` | [string](/fhir-elements/primitive/string) | `0..1` | A name that this endpoint can be identified by |
| <span id="element-managing-organization"></span>`managingOrganization` | [Reference](/fhir-elements/complex/reference) | `0..1` | Organization that manages this endpoint (might not be the organization that exposes the endpoint) |
| <span id="element-contact"></span>`contact` | [ContactPoint](/fhir-elements/complex/contact-point) | `0..*` | Contact details for source (e.g. troubleshooting) |
| <span id="element-period"></span>`period` | [Period](/fhir-elements/complex/period) | `0..1` | Interval the endpoint is expected to be operational |
| <span id="element-payload-type"></span>`payloadType` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `1..*` | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) |
| <span id="element-payload-mime-type"></span>`payloadMimeType` | [code](/fhir-elements/primitive/code) | `0..*` | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) |
| <span id="element-address"></span>`address` | [url](/fhir-elements/primitive/url) | `1..1` | The technical base address for connecting to this endpoint |
| <span id="element-header"></span>`header` | [string](/fhir-elements/primitive/string) | `0..*` | Usage depends on the channel type |

## Resource-specific search parameters [#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 [#reference]

Official FHIR R4 spec: [Endpoint](https://hl7.org/fhir/R4/endpoint.html).  
Maturity: Trial Use 2 (FMM 2).
