description: 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.
package_name: hl7.fhir.r6.core
derivation: specialization
name: Endpoint
type: Endpoint
elements:
  description: {isModifier: false, short: Additional details about the endpoint that could be displayed as further information to identify the description beyond its name, type: string, mustSupport: false, isSummary: true, index: 4}
  connectionType:
    min: 1
    isModifier: false
    short: Protocol/Profile/Standard to be used with this endpoint connection
    index: 2
    type: CodeableConcept
    mustSupport: false
    array: true
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/endpoint-connection-type'}
    isSummary: true
  address: {isModifier: false, short: The technical base address for connecting to this endpoint, type: url, mustSupport: false, isSummary: true, index: 15}
  availability: {isModifier: false, short: Times the endpoint is expected to be available (including exceptions), type: Availability, mustSupport: false, isSummary: false, index: 9}
  payload:
    isModifier: false
    short: Set of payloads that are provided by this endpoint
    type: BackboneElement
    mustSupport: false
    array: true
    isSummary: false
    index: 10
    elements:
      type:
        isModifier: false
        short: The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
        type: CodeableConcept
        mustSupport: false
        array: true
        binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/endpoint-payload-type'}
        isSummary: true
        index: 11
      mimeType:
        isModifier: false
        short: Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
        type: code
        mustSupport: false
        array: true
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/mimetypes|6.0.0-ballot4'}
        isSummary: true
        index: 12
      profileCanonical: {isModifier: false, short: The profile that is expected at this endpoint, type: canonical, mustSupport: false, array: true, isSummary: false, index: 13}
      profileUri: {isModifier: false, short: The non-fhir based profile that is expected at this endpoint, type: uri, mustSupport: false, array: true, isSummary: false, index: 14}
  managingOrganization:
    isModifier: false
    short: Organization that manages this endpoint (might not be the organization that exposes the endpoint)
    refers: ['http://hl7.org/fhir/StructureDefinition/Organization']
    type: Reference
    mustSupport: false
    isSummary: true
    index: 6
  name: {isModifier: false, short: A name that this endpoint can be identified by, type: string, mustSupport: false, isSummary: true, index: 3}
  environmentType:
    isModifier: false
    short: The type of environment(s) exposed at this endpoint
    type: CodeableConcept
    mustSupport: false
    array: true
    binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/endpoint-environment'}
    isSummary: true
    index: 5
  header: {isModifier: false, short: Usage depends on the channel type, type: string, mustSupport: false, array: true, isSummary: false, index: 16}
  status:
    isModifier: true
    short: active | limited | suspended | error | off | entered-in-error
    index: 1
    type: code
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/endpoint-status|6.0.0-ballot4'}
    isModifierReason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    isSummary: true
  identifier: {isModifier: false, short: Identifies this endpoint across multiple systems, type: Identifier, mustSupport: false, array: true, isSummary: true, index: 0}
  period: {isModifier: false, short: Interval the endpoint is expected to be operational, type: Period, mustSupport: false, isSummary: true, index: 8}
  contact: {isModifier: false, short: Contact details for source (e.g. troubleshooting), type: ContactPoint, mustSupport: false, array: true, isSummary: false, index: 7}
package_version: 6.0.0-ballot4
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/Endpoint
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: 6.0.0-ballot4
required: [connectionType, address, status]