description: Base StructureDefinition for Endpoint Resource
package_name: hl7.fhir.core
derivation: specialization
name: Endpoint
type: Endpoint
elements:
  connectionType: {short: Protocol/Profile/Standard to be used with this endpoint connection, comments: 'For additional connectivity details for the protocol, extensions will be used at this point, as in the XDS example.', type: Coding, isSummary: true, index: 6}
  address: {short: The technical address for conneccting to this endpoint, comments: 'For rest-hook, and websocket, the end-point must be an http: or https: URL; for email, a mailto: url, for sms, a tel: url, and for message the endpoint can be in any form of url the server understands (usually, http: or mllp:). The URI is allowed to be relative; in which case, it is relative to the server end-point (since their may be more than one, clients should avoid using relative URIs).', type: uri, isSummary: true, index: 9}
  managingOrganization:
    short: Organization that manages this endpoint (may not be the organization that exposes the endpoint)
    refers: ['http://hl7.org/fhir/StructureDefinition/Organization']
    comments: This property is not typically used when searching for Endpoint resources for usage. The typical usage is via the reference from an aplicable Organization/Location/Practitioner resource, which is where the context is provided. Multiple Locations may reference a single endpoint, and don't have to be within the same organization resource, but most likely within the same organizational heirarchy.
    type: Reference
    isSummary: true
    index: 3
  name: {short: A name that this endpoint can be identified by, type: string, isSummary: true, index: 2}
  payloadMimeType: {short: 'Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)', comments: Sending the payload has obvious security consequences. The server is responsible for ensuring that the content is appropriately secured., type: code, array: true, isSummary: true, index: 8}
  payloadType: {min: 1, short: The type of content that may be used at this endpoint (e.g. XDS Discharge summaries), comments: 'The payloadFormat describes the wire format of the data, where the payloadType indicates the specific document/schema that is being transferred. E.g. DischargeSummary or CarePlan.', type: CodeableConcept, array: true, isSummary: true, index: 7}
  header: {short: Usage depends on the channel type, comments: Exactly what these mean depend on the channel type. The can convey additional information to the recipient and/or meet security requirements., type: string, array: true, isSummary: false, index: 10}
  publicKey: {type: string, short: PKI Public keys to support secure communications, index: 11}
  status: {isModifier: true, short: active | suspended | error | off | entered-in-error | test, type: code, isSummary: true, index: 1}
  identifier: {short: Identifies this endpoint across multiple systems, type: Identifier, array: true, isSummary: true, index: 0}
  period: {short: Interval the endpoint is expected to be operational, type: Period, isSummary: true, index: 5}
  contact: {type: ContactPoint, short: Contact details for source (e.g. troubleshooting), array: true, index: 4}
package_version: 1.8.0
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/Endpoint
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: null
required: [connectionType, payloadType, address, status]