<StructureDefinition xmlns="http://hl7.org/fhir">
  <id value="Endpoint" />
  <meta>
    <lastUpdated value="2021-01-02T08:58:31.578+11:00" />
  </meta>
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-category">
    <valueString value="Base.Entities" />
  </extension>
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="trial-use" />
  </extension>
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="2" />
  </extension>
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category">
    <valueCode value="business" />
  </extension>
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="pa" />
  </extension>
  <extension url="http://hl7.org/fhir/build/StructureDefinition/entered-in-error-status">
    <valueCode value=".status=entered-in-error" />
  </extension>
  <url value="http://hl7.org/fhir/StructureDefinition/Endpoint" />
  <version value="4.6.0" />
  <name value="Endpoint" />
  <status value="draft" />
  <date value="2021-01-02T08:58:31+11:00" />
  <publisher value="Health Level Seven International (Patient Administration)" />
  <contact>
    <telecom>
      <system value="url" />
      <value value="http://hl7.org/fhir" />
    </telecom>
  </contact>
  <contact>
    <telecom>
      <system value="url" />
      <value value="http://www.hl7.org/Special/committees/pafm/index.cfm" />
    </telecom>
  </contact>
  <description value="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." />
  <fhirVersion value="4.6.0" />
  <mapping>
    <identity value="rim" />
    <uri value="http://hl7.org/v3" />
    <name value="RIM Mapping" />
  </mapping>
  <mapping>
    <identity value="w5" />
    <uri value="http://hl7.org/fhir/fivews" />
    <name value="FiveWs Pattern Mapping" />
  </mapping>
  <kind value="resource" />
  <abstract value="false" />
  <type value="Endpoint" />
  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/DomainResource" />
  <derivation value="specialization" />
  <differential>
    <element id="Endpoint">
      <extension url="http://hl7.org/fhir/build/StructureDefinition/svg">
        <valueCode value="200,0" />
      </extension>
      <path value="Endpoint" />
      <short value="The technical details of an endpoint that can be used for electronic services" />
      <definition value="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." />
      <min value="0" />
      <max value="*" />
      <mapping>
        <identity value="rim" />
        <map value="n/a" />
      </mapping>
      <mapping>
        <identity value="w5" />
        <map value="infrastructure.exchange" />
      </mapping>
    </element>
    <element id="Endpoint.identifier">
      <path value="Endpoint.identifier" />
      <short value="Identifies this endpoint across multiple systems" />
      <definition value="Identifier for the organization that is used to identify the endpoint across multiple disparate systems." />
      <min value="0" />
      <max value="*" />
      <type>
        <code value="Identifier" />
      </type>
      <isSummary value="true" />
      <mapping>
        <identity value="w5" />
        <map value="FiveWs.identifier" />
      </mapping>
      <mapping>
        <identity value="rim" />
        <map value="n/a" />
      </mapping>
    </element>
    <element id="Endpoint.status">
      <path value="Endpoint.status" />
      <short value="active | suspended | error | off | entered-in-error | test" />
      <definition value="active | suspended | error | off | test." />
      <comment value="This element is labeled as a modifier because the status contains codes that mark the endpoint as not currently valid." />
      <min value="1" />
      <max value="1" />
      <type>
        <code value="code" />
      </type>
      <isModifier value="true" />
      <isModifierReason value="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 value="true" />
      <binding>
        <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
          <valueString value="EndpointStatus" />
        </extension>
        <strength value="required" />
        <description value="The status of the endpoint." />
        <valueSet value="http://hl7.org/fhir/ValueSet/endpoint-status" />
      </binding>
      <mapping>
        <identity value="w5" />
        <map value="FiveWs.status" />
      </mapping>
      <mapping>
        <identity value="rim" />
        <map value="n/a" />
      </mapping>
    </element>
    <element id="Endpoint.connectionType">
      <path value="Endpoint.connectionType" />
      <short value="Protocol/Profile/Standard to be used with this endpoint connection" />
      <definition value="A coded value that represents the technical details of the usage of this endpoint, such as what WSDLs should be used in what way. (e.g. XDS.b/DICOM/cds-hook)." />
      <comment value="For additional connectivity details for the protocol, extensions will be used at this point, as in the XDS example." />
      <min value="1" />
      <max value="1" />
      <type>
        <code value="Coding" />
      </type>
      <isSummary value="true" />
      <binding>
        <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
          <valueString value="endpoint-contype" />
        </extension>
        <strength value="extensible" />
        <valueSet value="http://hl7.org/fhir/ValueSet/endpoint-connection-type" />
      </binding>
      <mapping>
        <identity value="w5" />
        <map value="FiveWs.class" />
      </mapping>
      <mapping>
        <identity value="rim" />
        <map value="n/a" />
      </mapping>
    </element>
    <element id="Endpoint.name">
      <path value="Endpoint.name" />
      <short value="A name that this endpoint can be identified by" />
      <definition value="A friendly name that this endpoint can be referred to with." />
      <min value="0" />
      <max value="1" />
      <type>
        <code value="string" />
      </type>
      <isSummary value="true" />
      <mapping>
        <identity value="w5" />
        <map value="FiveWs.what[x]" />
      </mapping>
      <mapping>
        <identity value="rim" />
        <map value="n/a" />
      </mapping>
    </element>
    <element id="Endpoint.managingOrganization">
      <extension url="http://hl7.org/fhir/build/StructureDefinition/committee-notes">
        <valueString value="This was left as 0..1 to permit small systems having an implied Organization." />
      </extension>
      <path value="Endpoint.managingOrganization" />
      <short value="Organization that manages this endpoint (might not be the organization that exposes the endpoint)" />
      <definition value="The organization that manages this endpoint (even if technically another organization is hosting this in the cloud, it is the organization associated with the data)." />
      <comment value="This property is not typically used when searching for Endpoint resources for usage. The typical usage is via the reference from an applicable 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 hierarchy." />
      <min value="0" />
      <max value="1" />
      <type>
        <code value="Reference" />
        <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization" />
      </type>
      <isSummary value="true" />
      <mapping>
        <identity value="rim" />
        <map value="n/a" />
      </mapping>
    </element>
    <element id="Endpoint.contact">
      <path value="Endpoint.contact" />
      <short value="Contact details for source (e.g. troubleshooting)" />
      <definition value="Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting." />
      <min value="0" />
      <max value="*" />
      <type>
        <code value="ContactPoint" />
      </type>
      <mapping>
        <identity value="rim" />
        <map value="n/a" />
      </mapping>
    </element>
    <element id="Endpoint.period">
      <path value="Endpoint.period" />
      <short value="Interval the endpoint is expected to be operational" />
      <definition value="The interval during which the endpoint is expected to be operational." />
      <min value="0" />
      <max value="1" />
      <type>
        <code value="Period" />
      </type>
      <isSummary value="true" />
      <mapping>
        <identity value="w5" />
        <map value="FiveWs.done[x]" />
      </mapping>
      <mapping>
        <identity value="rim" />
        <map value="n/a" />
      </mapping>
    </element>
    <element id="Endpoint.payloadType">
      <path value="Endpoint.payloadType" />
      <short value="The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)" />
      <definition value="The payload type describes the acceptable content that can be communicated on the endpoint." />
      <comment value="The payloadFormat describes the serialization format of the data, where the payloadType indicates the specific document/schema that is being transferred; e.g. DischargeSummary or CarePlan." />
      <min value="1" />
      <max value="*" />
      <type>
        <code value="CodeableConcept" />
      </type>
      <isSummary value="true" />
      <binding>
        <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
          <valueString value="PayloadType" />
        </extension>
        <strength value="example" />
        <valueSet value="http://hl7.org/fhir/ValueSet/endpoint-payload-type" />
      </binding>
      <mapping>
        <identity value="rim" />
        <map value="n/a" />
      </mapping>
    </element>
    <element id="Endpoint.payloadMimeType">
      <path value="Endpoint.payloadMimeType" />
      <short value="Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)" />
      <definition value="The mime type to send the payload in - e.g. application/fhir+xml, application/fhir+json. If the mime type is not specified, then the sender could send any content (including no content depending on the connectionType)." />
      <comment value="Sending the payload has obvious security consequences. The server is responsible for ensuring that the content is appropriately secured." />
      <min value="0" />
      <max value="*" />
      <type>
        <code value="code" />
      </type>
      <isSummary value="true" />
      <binding>
        <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName">
          <valueString value="MimeType" />
        </extension>
        <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding">
          <valueBoolean value="true" />
        </extension>
        <extension url="http://hl7.org/fhir/build/StructureDefinition/definition">
          <valueString value="The mime type of an attachment. Any valid mime type is allowed." />
        </extension>
        <strength value="required" />
        <description value="BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)" />
        <valueSet value="http://hl7.org/fhir/ValueSet/mimetypes" />
      </binding>
      <mapping>
        <identity value="rim" />
        <map value="n/a" />
      </mapping>
    </element>
    <element id="Endpoint.address">
      <path value="Endpoint.address" />
      <short value="The technical base address for connecting to this endpoint" />
      <definition value="The uri that describes the actual end-point to connect to." />
      <comment value="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 there may be more than one, clients should avoid using relative URIs)&#xA;&#xA;This address will be to the service base, without any parameters, or sub-services or resources tacked on.&#xA;&#xA;E.g. for a WADO-RS endpoint, the url should be &quot;https://pacs.hospital.org/wado-rs&quot;&#xA;&#xA;and not &quot;https://pacs.hospital.org/wado-rs/studies/1.2.250.1.59.40211.12345678.678910/series/1.2.250.1.59.40211.789001276.14556172.67789/instances/...&quot;." />
      <min value="1" />
      <max value="1" />
      <type>
        <code value="url" />
      </type>
      <isSummary value="true" />
      <mapping>
        <identity value="rim" />
        <map value="n/a" />
      </mapping>
    </element>
    <element id="Endpoint.header">
      <path value="Endpoint.header" />
      <short value="Usage depends on the channel type" />
      <definition value="Additional headers / information to send as part of the notification." />
      <comment value="Exactly what these mean depends on the channel type. The can convey additional information to the recipient and/or meet security requirements." />
      <min value="0" />
      <max value="*" />
      <type>
        <code value="string" />
      </type>
      <isSummary value="false" />
    </element>
  </differential>
</StructureDefinition>