Endpoint
Endpoint
draftResource26 elementsv5.0.0
The technical details of an endpoint that can be used for electronic services, such as for web services providing XDS.b, a REST endpoint for another FHIR server, or a s/Mime email address. This may include any security context information.
Metadata
hl7.org/fhir- Canonical URL
- http://hl7.org/fhir/StructureDefinition/Endpoint
- ID
- Endpoint
- Type
- Base Definition
- Derivation
- specialization
- Publisher
- Health Level Seven International (Patient Administration)
- Version
- 5.0.0
| Path | Card. | Type | Description |
|---|---|---|---|
Endpoint | 0..* | The technical details of an endpoint that can be used for electronic services | |
id | 0..1 | string | Logical id of this artifact |
meta | 0..1 | Metadata about the resource | |
implicitRules | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource contentrequired: all-languages |
text | 0..1 | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources |
extension | 0..* | Additional content defined by implementations | |
modifierExtension | 0..* | Extensions that cannot be ignored | |
identifier | 0..* | Identifies this endpoint across multiple systems | |
status | 1..1 | code | active | suspended | error | off | entered-in-error | testrequired: endpoint-status |
connectionType | 1..* | Protocol/Profile/Standard to be used with this endpoint connectionexample: endpoint-connection-type | |
name | 0..1 | string | A name that this endpoint can be identified by |
description | 0..1 | string | Additional details about the endpoint that could be displayed as further information to identify the description beyond its name |
environmentType | 0..* | The type of environment(s) exposed at this endpointextensible: endpoint-environment | |
managingOrganization | 0..1 | Organization that manages this endpoint (might not be the organization that exposes the endpoint) | |
contact | 0..* | Contact details for source (e.g. troubleshooting) | |
period | 0..1 | Interval the endpoint is expected to be operational | |
payload | 0..* | BackboneElement | Set of payloads that are provided by this endpoint |
address | 1..1 | url | The technical base address for connecting to this endpoint |
header | 0..* | string | Usage depends on the channel type |