Endpoint
BaseThe 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.
| Path | Card. | Type | Description & Constraints |
|---|---|---|---|
| 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 | Meta | 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 content Bindinglanguages(preferred) |
| .text | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| .contained | 0..* | Resource | Contained, inline Resources |
| .extension | 0..* | Extension | Additional content defined by implementations |
| .modifierExtension?! | 0..* | Extension | Extensions that cannot be ignored |
| .identifierΣ | 0..* | Identifier | Identifies this endpoint across multiple systems |
| .status?!Σ | 1..1 | code | active | suspended | error | off | entered-in-error | test Bindingendpoint-status(required) |
| .connectionTypeΣ | 1..1 | Coding | Protocol/Profile/Standard to be used with this endpoint connection Bindingendpoint-connection-type(extensible) |
| .nameΣ | 0..1 | string | A name that this endpoint can be identified by |
| .managingOrganizationΣ | 0..1 | Reference(Organization) | Organization that manages this endpoint (might not be the organization that exposes the endpoint) |
| .contact | 0..* | ContactPoint | Contact details for source (e.g. troubleshooting) |
| .periodΣ | 0..1 | Period | Interval the endpoint is expected to be operational |
| .payloadTypeΣ | 1..* | CodeableConcept | The type of content that may be used at this endpoint (e.g. XDS Discharge summaries) Bindingendpoint-payload-type(example) |
| .payloadMimeTypeΣ | 0..* | code | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) Bindingmimetypes(required) |
| .addressΣ | 1..1 | url | The technical base address for connecting to this endpoint |
| .header | 0..* | string | Usage depends on the channel type |