Resources
Endpoint
Resources
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.
Properties
| Name | Required | Type | Description |
|---|---|---|---|
| identifier | No | Identifier[] | Identifies this endpoint across multiple systems |
| status | Yes | code | active / suspended / error / off / entered-in-error / test |
| connectionType | Yes | Coding | Protocol/Profile/Standard to be used with this endpoint connection |
| name | No | string | A name that this endpoint can be identified by |
| managingOrganization | No | Reference<Organization> | Organization that manages this endpoint (might not be the organization that exposes the endpoint) |
| contact | No | ContactPoint[] | Contact details for source (e.g. troubleshooting) |
| period | No | Period | Interval the endpoint is expected to be operational |
| payloadType | Yes | CodeableConcept[] | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) |
| payloadMimeType | No | code[] | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) |
| address | Yes | url | The technical base address for connecting to this endpoint |
| header | No | string[] | Usage depends on the channel type |
Search Parameters
| Name | Type | Description | Expression |
|---|---|---|---|
| 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 |
Inherited Properties
| Name | Required | Type | Description |
|---|---|---|---|
| id | No | string | Logical id of this artifact |
| meta | No | Meta | Metadata about the resource |
| implicitRules | No | uri | A set of rules under which this content was created |
| language | No | code | Language of the resource content |
| text | No | Narrative | Text summary of the resource, for human interpretation |
| contained | No | Resource[] | Contained, inline Resources |
| extension | No | Extension[] | Additional content defined by implementations |
| modifierExtension | No | Extension[] | Extensions that cannot be ignored |
To view the FHIR specification for this resource, see Endpoint.